Operations (sample payloads)

Main operations

Create account

Creates an account. Sample Input

{
    "access_token": "your_access_token_here",
    "fields": {
        "full_name": "Acme Corporation",
        "domain": "acmecorp.com",
        "conversational_name": "Acme",
        "description": "A leading provider of innovative solutions",
        "phone": "1234567890",
        "website": "https://www.acmecorp.com",
        "linkedin_url": "https://www.linkedin.com/company/acmecorp",
        "twitter_handle": "@acmecorp",
        "street": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country": "USA",
        "locale": "en_US",
        "industry": "Technology",
        "company_type": "B2B",
        "founded": "2005",
        "revenue_range": "$10M - $50M",
        "size": "100-500",
        "do_not_contact": false,
        "custom_fields": [
            \{
                "key": "Customer Segment",
                "value": "Enterprise"
            \}
        ],
        "tags": [
            "tech",
            "saas",
            "enterprise"
        ],
        "owner_id": 12345,
        "company_stage_id": 2,
        "account_tier_id": 3
    }
}

Sample Output

Create bulk job

Creates a bulk job. Sample Input Sample Output

{
    "data": \{
        "created_at": "2023-06-15T14:30:22Z",
        "errors": 0,
        "id": 12345,
        "name": "New Customer Import June 2023",
        "processed": 0,
        "ready_to_execute": true,
        "scopes": [
            "person_write"
        ],
        "state": "pending",
        "total": 0,
        "type": "person/upsert"
    \}
}

Create bulk job data

Creates job data for the specified bulk job. Sample Input Sample Output

{
    "data": {
        "records": 3
    }
}

Create cadence membership

Adds a person to a cadence. A person cannot be added to a cadence on behalf of a teammate unless the cadence is a team cadence, or the cadence is owned by the teammate. Sample Input Sample Output

{
    "data": {
        "id": 98765,
        "added_at": "2023-05-15T10:30:00Z",
        "created_at": "2023-05-15T10:30:00Z",
        "updated_at": "2023-05-15T10:30:00Z",
        "person_deleted": false,
        "currently_on_cadence": true,
        "current_state": "active",
        "cadence": \{
            "_href": "https://api.salesloft.com/v2/cadences/67890",
            "id": 67890
        \},
        "person": \{
            "_href": "https://api.salesloft.com/v2/people/12345",
            "id": 12345
        \},
        "user": \{
            "_href": "https://api.salesloft.com/v2/users/54321",
            "id": 54321
        \},
        "latest_action": {
            "id": 11111
        },
        "counts": \{
            "views": 0,
            "clicks": 0,
            "replies": 0,
            "calls": 0,
            "sent_emails": 0,
            "bounces": 0
        \}
    }
}

Create call

Creates a call. The parameters of this endpoint can be used to create an action and ensure that the CRM Task is mapped correctly. Sample Input Sample Output

Create custom field

Creates a custom field. Sample Input Sample Output

Create import

Creates an import. Sample Input Sample Output

Create note

Creates a note. Sample Input Sample Output

Create person

Creates a person. Either email address or phone/last_name must be provided as a unique lookup on the team. Sample Input Sample Output

{
    "data": {
        "id": 987654,
        "created_at": "2023-04-16T10:30:00Z",
        "updated_at": "2023-04-16T10:30:00Z",
        "last_contacted_at": null,
        "last_replied_at": null,
        "first_name": "John",
        "last_name": "Doe",
        "display_name": "John Doe",
        "email_address": "john.doe@example.com",
        "full_email_address": "John Doe <john.doe@example.com>",
        "secondary_email_address": null,
        "personal_email_address": null,
        "phone": "1234567890",
        "phone_extension": null,
        "home_phone": null,
        "mobile_phone": null,
        "linkedin_url": "https://www.linkedin.com/in/johndoe",
        "title": "Sales Manager",
        "city": "New York",
        "state": "NY",
        "country": "USA",
        "work_city": null,
        "work_state": null,
        "work_country": null,
        "crm_url": null,
        "crm_id": null,
        "crm_object_type": null,
        "owner_crm_id": null,
        "person_company_name": "Acme Corp",
        "person_company_website": "https://www.acmecorp.com",
        "person_company_industry": "Technology",
        "do_not_contact": false,
        "bouncing": false,
        "locale": null,
        "personal_website": null,
        "twitter_handle": "@johndoe",
        "last_contacted_type": null,
        "job_seniority": "manager",
        "custom_fields": \{
            "Lead Source": "Website",
            "Last Interaction": "2023-04-15"
        \},
        "tags": [
            "prospect",
            "tech industry"
        ],
        "contact_restrictions": [],
        "counts": \{
            "emails_sent": 0,
            "emails_viewed": 0,
            "emails_clicked": 0,
            "emails_replied_to": 0,
            "emails_bounced": 0,
            "calls": 0
        \},
        "account": \{
            "id": 12345,
            "_href": "https://api.salesloft.com/v2/accounts/12345"
        \},
        "owner": \{
            "id": 67890,
            "_href": "https://api.salesloft.com/v2/users/67890"
        \},
        "last_contacted_by": null,
        "import": null,
        "person_stage": null
    }
}

Create person stage

Creates a person stage. Sample Input Sample Output

Create task

Creates a task. Sample Input Sample Output

Delete account

Deletes an account. This operation is not reversible without contacting SalesLoft support. Sample Input Sample Output

Delete cadence membership

Deletes a cadence membership. Sample Input Sample Output

Delete custom field

Deletes a custom field. Sample Input Sample Output

Delete import

Deletes an import, by ID only. The associated people can be deleted as part of the deletion process. Sample Input Sample Output

Delete note

Deletes a note. Sample Input Sample Output

Delete person

Deletes a person. Sample Input

\{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "person_id": 12345
\}

Sample Output

{
    "success": true
}

Delete person stage

Deletes a person stage. Sample Input Sample Output

{
    "success": true
}

Get account

Returns information about an account. Sample Input

\{
    "access_token": "your_access_token_here",
    "account_id": "12345"
\}

Sample Output

Get bulk job

Retrieves a bulk job. Sample Input

\{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "bulk_jobs_id": 12345
\}

Sample Output

Get cadence

Retrieves a cadence by ID. Sample Input Sample Output

{
    "data": {
        "id": 12345,
        "created_at": "2023-05-15T10:30:00Z",
        "updated_at": "2023-05-20T14:45:00Z",
        "archived_at": null,
        "team_cadence": true,
        "shared": false,
        "remove_bounces_enabled": true,
        "remove_replies_enabled": true,
        "opt_out_link_included": true,
        "draft": false,
        "cadence_framework_id": "abcdef123456",
        "cadence_function": "outreach",
        "name": "Q2 Sales Outreach",
        "tags": [
            "sales",
            "outreach",
            "q2"
        ],
        "creator": \{
            "_href": "/v2/users/789",
            "id": 789
        \},
        "owner": \{
            "_href": "/v2/users/456",
            "id": 456
        \},
        "bounced_stage": \{
            "id": 101,
            "_href": "/v2/cadence_stages/101"
        \},
        "replied_stage": \{
            "id": 102,
            "_href": "/v2/cadence_stages/102"
        \},
        "added_stage": \{
            "id": 103,
            "_href": "/v2/cadence_stages/103"
        \},
        "finished_stage": \{
            "id": 104,
            "_href": "/v2/cadence_stages/104"
        \},
        "cadence_priority": "normal",
        "counts": \{
            "cadence_people": 500,
            "people_acted_on_count": 350,
            "target_daily_people": 50,
            "opportunities_created": 25,
            "meetings_booked": 15
        \}
    }
}

Get cadence membership

Returns information about a cadence membership. Sample Input Sample Output

{
    "data": {
        "id": 12345,
        "added_at": "2023-05-15T10:30:00Z",
        "created_at": "2023-05-15T10:30:00Z",
        "updated_at": "2023-05-16T14:45:00Z",
        "person_deleted": false,
        "currently_on_cadence": true,
        "current_state": "active",
        "cadence": \{
            "_href": "https://api.salesloft.com/v2/cadences/67890",
            "id": 67890
        \},
        "person": \{
            "_href": "https://api.salesloft.com/v2/people/54321",
            "id": 54321
        \},
        "user": \{
            "_href": "https://api.salesloft.com/v2/users/98765",
            "id": 98765
        \},
        "latest_action": {
            "id": 23456
        },
        "counts": \{
            "views": 15,
            "clicks": 7,
            "replies": 3,
            "calls": 2,
            "sent_emails": 5,
            "bounces": 0
        \}
    }
}

Get call

Gets a call by ID. Sample Input

\{
    "access_token": "your_access_token_here",
    "call_id": 12345
\}

Sample Output

{
    "data": {
        "id": 12345,
        "to": "+14155551234",
        "duration": 180,
        "sentiment": "positive",
        "disposition": "completed",
        "created_at": "2023-05-15T14:30:00Z",
        "updated_at": "2023-05-15T14:33:00Z",
        "recordings": [
            \{
                "url": "https://example.com/recordings/12345.mp3",
                "recording_status": "completed",
                "status": "available"
            \}
        ],
        "user": \{
            "id": 67890,
            "_href": "https://api.salesloft.com/v2/users/67890"
        \},
        "action": {
            "id": 54321
        },
        "called_person": \{
            "id": 98765,
            "_href": "https://api.salesloft.com/v2/people/98765"
        \},
        "crm_activity": \{
            "id": 11111,
            "_href": "https://api.salesloft.com/v2/crm_activities/11111"
        \},
        "note": \{
            "id": 22222,
            "_href": "https://api.salesloft.com/v2/notes/22222"
        \},
        "cadence": \{
            "id": 33333,
            "_href": "https://api.salesloft.com/v2/cadences/33333"
        \},
        "step": \{
            "id": 44444,
            "_href": "https://api.salesloft.com/v2/steps/44444"
        \}
    }
}

Get custom field

Returns information about a custom field. Sample Input

\{
    "access_token": "your_access_token_here",
    "custom_field_id": 12345
\}

Sample Output

Get email

Gets an email record. Sample Input Sample Output

Get import

Fetches an import, by ID only. Sample Input Sample Output

Get note

Gets a note. Sample Input Sample Output

Get person

Get a person by ID. Sample Input Sample Output

Get person stage

Gets a person stage by ID. Sample Input

\{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
    "person_stage_id": 12345
\}

Sample Output

Get step

Gets a step by ID. Sample Input Sample Output

Get task

Retrieves a task by ID. Sample Input Sample Output

{
    "data": {
        "id": 12345,
        "created_at": "2023-05-15T10:30:00Z",
        "updated_at": "2023-05-16T14:45:00Z",
        "due_date": "2023-05-20",
        "due_at": "2023-05-20T17:00:00Z",
        "subject": "Follow up with potential client",
        "current_state": "pending",
        "task_type": "call",
        "remind_at": "2023-05-19T09:00:00Z",
        "completed_at": null,
        "person": \{
            "_href": "/v2/people/67890",
            "id": 67890
        \},
        "user": \{
            "_href": "/v2/users/54321",
            "id": 54321
        \},
        "created_by_user": \{
            "_href": "/v2/users/54321",
            "id": 54321
        \},
        "completed_by": null
    }
}

Get user

Gets a user by ID. Sample Input Sample Output

List account stages

Returns a list of available account stages. Sample Input Sample Output

List account tiers

Returns a list of available account tiers. Sample Input Sample Output

List accounts

Returns a list of accounts. Sample Input Sample Output

{
    "metadata": {
        "filtering": {
            "tag": [
                "VIP",
                "Enterprise"
            ],
            "account_tier_id": [
                "1",
                "2"
            ],
            "updated_at": \{
                "gte": "2023-01-01T00:00:00Z",
                "lt": "2023-06-01T00:00:00Z"
            \}
        },
        "paging": \{
            "per_page": 10,
            "current_page": 1,
            "next_page": 2,
            "prev_page": null
        \},
        "sorting": \{
            "sort_by": "updated_at",
            "sort_direction": "DESC"
        \}
    },
    "data": [
        {
            "id": 12345,
            "created_at": "2022-11-15T09:30:00Z",
            "updated_at": "2023-05-20T14:45:00Z",
            "archived_at": null,
            "name": "Acme Corporation",
            "domain": "acmecorp.com",
            "conversational_name": "Acme",
            "description": "Leading provider of innovative solutions",
            "phone": "+1 (555) 123-4567",
            "website": "https://www.acmecorp.com",
            "linkedin_url": "https://www.linkedin.com/company/acmecorp",
            "twitter_handle": "@AcmeCorp",
            "street": "123 Main St",
            "city": "San Francisco",
            "state": "CA",
            "postal_code": "94105",
            "country": "United States",
            "locale": "en-US",
            "industry": "Technology",
            "company_type": "Public",
            "founded": "1985",
            "revenue_range": "$100M-$500M",
            "size": "1000-5000",
            "crm_id": "0015A00000XYZ123",
            "crm_url": "https://example.salesforce.com/0015A00000XYZ123",
            "crm_object_type": "Account",
            "owner_crm_id": "00580000001XYZ",
            "last_contacted_at": "2023-05-18T10:30:00Z",
            "last_contacted_type": "email",
            "do_not_contact": false,
            "custom_fields": {
                "Custom Company Field": "VIP Client"
            },
            "tags": [
                "VIP",
                "Enterprise"
            ],
            "counts": {
                "people": 25
            },
            "owner": \{
                "_href": "/v2/users/67890",
                "id": 67890
            \},
            "creator": \{
                "_href": "/v2/users/12345",
                "id": 12345
            \},
            "last_contacted_by": \{
                "_href": "/v2/users/23456",
                "id": 23456
            \},
            "last_contacted_person": \{
                "_href": "/v2/people/34567",
                "id": 34567
            \},
            "company_stage": \{
                "_href": "/v2/company_stages/2",
                "id": 2
            \},
            "account_tier": \{
                "id": 1,
                "_href": "/v2/account_tiers/1"
            \}
        }
    ]
}

List actions

Lists multiple action records. If the requesters is not an admin, this endpoint will only return actions belonging to the requester. If the requester is an admin, this endpoint will return actions for the entire team. Additionally, an admin may use the user GUID parameter to request actions that belong to specific users on the team. Sample Input Sample Output

List bulk job results

Retrieves multiple job data records for a completed bulk job. Sample Input Sample Output

List cadence memberships

Returns a list of cadence memberships. Sample Input Sample Output

List cadences

Lists multiple cadence records. Sample Input

{
    "access_token": "your_access_token_here",
    "cadence_ids": [
        123,
        "456",
        789
    ],
    "updated_at": \{
        "gte": "2023-01-01T00:00:00Z",
        "lt": "2023-06-01T00:00:00Z"
    \},
    "team_cadence": true,
    "shared": false,
    "owned_by_guid_filter": [
        "user_guid_1",
        "user_guid_2"
    ],
    "people_addable": true,
    "name": [
        "Sales Outreach",
        "Marketing Campaign"
    ],
    "sort_by": "updated_at",
    "sort_direction": "DESC",
    "include_paging_counts": true,
    "per_page": 50,
    "page": 1
}

Sample Output

List call data records

Lists multiple call data records. Sample Input Sample Output

List call dispositions

Lists multiple call disposition records. Sample Input

\{
    "access_token": "your_access_token_here",
    "sort_by": "updated_at",
    "sort_direction": "DESC",
    "include_paging_counts": true,
    "per_page": 50,
    "page": 1
\}

Sample Output

List call sentiments

Lists multiple call sentiment records. Sample Input Sample Output

List caller IDs

Returns a possible caller ID match for the number. Multiple entries may be returned if the phone number is present on more than one person in the system. Phone number should be in E.164 format. Sample Input

\{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "phone_number": "+14155552671"
\}

Sample Output

List calls

Lists multiple call records. Sample Input Sample Output

List CRM activities

Lists multiple CRM activity records. Sample Input Sample Output

{
    "metadata": {
        "filtering": \{
            "ids": [
                "1234",
                "5678",
                "9012"
            ]
        \},
        "paging": \{
            "per_page": 50,
            "current_page": 1,
            "next_page": 2,
            "prev_page": null
        \},
        "sorting": \{
            "sort_by": "updated_at",
            "sort_direction": "DESC"
        \}
    },
    "data": [
        {
            "id": 9012,
            "created_at": "2023-05-28T14:30:00Z",
            "updated_at": "2023-05-29T09:15:00Z",
            "subject": "Follow-up call with client",
            "description": "Discussed project timeline and next steps",
            "crm_id": "CRM123456",
            "activity_type": "Call",
            "error": null,
            "custom_crm_fields": {
                "ecorp__Call_Type__c": "Follow-up"
            },
            "person": \{
                "id": 54321,
                "_href": "https://api.salesloft.com/v2/people/54321"
            \},
            "user": \{
                "id": 98765,
                "_href": "https://api.salesloft.com/v2/users/98765"
            \}
        },
        {
            "id": 5678,
            "created_at": "2023-05-15T10:00:00Z",
            "updated_at": "2023-05-15T11:30:00Z",
            "subject": "Demo presentation",
            "description": "Presented product features to potential client",
            "crm_id": "CRM789012",
            "activity_type": "Meeting",
            "error": null,
            "custom_crm_fields": {
                "ecorp__Call_Type__c": "Demo"
            },
            "person": \{
                "id": 67890,
                "_href": "https://api.salesloft.com/v2/people/67890"
            \},
            "user": \{
                "id": 12345,
                "_href": "https://api.salesloft.com/v2/users/12345"
            \}
        }
    ]
}

List CRM activity fields

Lists multiple CRM activity field records. Sample Input Sample Output

{
    "metadata": {
        "filtering": {
            "source": "salesforce"
        },
        "paging": \{
            "per_page": 50,
            "current_page": 1,
            "next_page": 2,
            "prev_page": null
        \},
        "sorting": \{
            "sort_by": "updated_at",
            "sort_direction": "DESC"
        \}
    },
    "data": [
        {
            "id": 12345,
            "created_at": "2023-05-15T10:30:00Z",
            "updated_at": "2023-05-16T14:45:00Z",
            "title": "Call Outcome",
            "salesforce_object_type": "Task",
            "source": "salesforce",
            "field": "Call_Outcome__c",
            "field_type": "picklist",
            "value": "Successful",
            "picklist_values": \{
                "High": "Successful",
                "Low": "No Answer"
            \}
        },
        {
            "id": 12346,
            "created_at": "2023-05-14T09:15:00Z",
            "updated_at": "2023-05-15T11:20:00Z",
            "title": "Meeting Notes",
            "salesforce_object_type": "Event",
            "source": "salesforce",
            "field": "Meeting_Notes__c",
            "field_type": "text",
            "value": "Discussed product features and pricing",
            "picklist_values": {}
        }
    ]
}

List custom fields

Returns a list of custom fields. Sample Input Sample Output

{
    "metadata": {
        "filtering": {
            "ids": []
        },
        "sorting": \{
            "sort_by": "updated_at",
            "sort_direction": "DESC"
        \},
        "paging": \{
            "per_page": 50,
            "current_page": 1,
            "next_page": 2,
            "prev_page": null
        \}
    },
    "data": [
        \{
            "id": 12345,
            "name": "Job Title",
            "field_type": "person",
            "value_type": "text",
            "created_at": "2023-02-15T10:30:00Z",
            "updated_at": "2023-05-20T14:45:00Z"
        \},
        \{
            "id": 12346,
            "name": "Industry",
            "field_type": "person",
            "value_type": "picklist",
            "created_at": "2023-03-01T09:00:00Z",
            "updated_at": "2023-05-18T11:20:00Z"
        \},
        \{
            "id": 12347,
            "name": "Last Contact Date",
            "field_type": "person",
            "value_type": "date",
            "created_at": "2023-01-10T16:00:00Z",
            "updated_at": "2023-05-15T08:30:00Z"
        \}
    ]
}

List emails

Lists multiple email records. Sample Input Sample Output

List groups

Returns a list of available groups. Sample Input Sample Output

List imports

Lists multiple imports. Sample Input

\{
    "access_token": "your_access_token_here",
    "import_ids": [
        123,
        456,
        789
    ],
    "user_ids": [
        1001,
        1002
    ],
    "sort_by": "created_at",
    "sort_direction": "DESC",
    "include_paging_counts": true,
    "per_page": 25,
    "page": 1
\}

Sample Output

List notes

Lists multiple note records. Sample Input Sample Output

List person stages

Lists multiple person stage records. Sample Input

\{
    "access_token": "your_access_token_here",
    "person_stage_ids": [
        1,
        2,
        3
    ],
    "sort_by": "updated_at",
    "sort_direction": "DESC",
    "include_paging_counts": true,
    "per_page": 25,
    "page": 1
\}

Sample Output

List steps

Lists multiple step records. Sample Input Sample Output

List tags

Fetches a list of the tags used for a team. Sample Input Sample Output

List tasks

Retrieves multiple task records. The records can be filtered, paged, and sorted according to the respective parameters. Sample Input Sample Output

List users

Returns a list of users associated with your team. Sample Input Sample Output

{
    "metadata": {
        "filtering": {
            "visible_only": true
        }
    },
    "data": [
        {
            "id": 12345,
            "guid": "abc123def456",
            "created_at": "2023-01-15T10:30:00Z",
            "updated_at": "2023-05-20T14:45:00Z",
            "name": "John Smith",
            "first_name": "John",
            "last_name": "Smith",
            "job_role": "Sales Representative",
            "active": true,
            "time_zone": "America/New_York",
            "slack_username": "johnsmith",
            "twitter_handle": "@johnsmith",
            "email": "john.smith@example.com",
            "email_client_email_address": "john.smith@mail.example.com",
            "sending_email_address": "john.smith@example.com",
            "from_address": "John Smith <john.smith@example.com>",
            "full_email_address": "John Smith <john.smith@example.com>",
            "bcc_email_address": "john.smith.bcc@example.com",
            "email_signature": "Best regards,\nJohn Smith\nSales Representative",
            "email_signature_type": "text",
            "email_signature_click_tracking_disabled": false,
            "team_admin": false,
            "local_dial_enabled": true,
            "click_to_call_enabled": true,
            "email_client_configured": true,
            "crm_connected": true,
            "external_feature_flags": \{
                "ma_enabled": true,
                "ma_live_feed": true,
                "ma_person_page": true,
                "ma_push_notifications": false,
                "ma_websockets": true,
                "ma_edit_person": true,
                "hot_leads": true
            \},
            "phone_client": {
                "id": 67890
            },
            "phone_number_assignment": \{
                "_href": "/api/v2/phone_number_assignments/54321",
                "id": 54321
            \},
            "group": 9876,
            "team": \{
                "_href": "/api/v2/teams/5432",
                "id": 5432
            \}
        }
    ]
}

Raw HTTP request (advanced)

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication. Sample Input

{
    "access_token": "your_access_token_here",
    "method": "GET",
    "url": {
        "endpoint": "/v2/people"
    },
    "headers": [
        \{
            "key": "Content-Type",
            "value": "application/json"
        \}
    ],
    "query_parameters": [
        \{
            "key": "per_page",
            "value": "50"
        \},
        \{
            "key": "page",
            "value": "1"
        \}
    ],
    "body": {
        "none": null
    },
    "include_raw_body": false,
    "parse_response": "true"
}

Sample Output

Update account

Updates an account. Sample Input Sample Output

Update bulk job

Updates a bulk job. Sample Input Sample Output

Update custom field

Update a custom field. (This invalidates the old custom field ID). Sample Input Sample Output

Update import

Updates an import. Sample Input Sample Output

Update note

Updates a note. Sample Input Sample Output

Update person

Updates a person. Sample Input Sample Output

{
    "data": {
        "id": 12345,
        "created_at": "2023-01-01T12:00:00Z",
        "updated_at": "2023-05-20T15:30:00Z",
        "last_contacted_at": "2023-05-18T10:15:00Z",
        "last_replied_at": "2023-05-18T11:30:00Z",
        "first_name": "John",
        "last_name": "Doe",
        "display_name": "John Doe",
        "email_address": "john.doe@example.com",
        "full_email_address": "John Doe <john.doe@example.com>",
        "phone": "1234567890",
        "title": "Sales Manager",
        "city": "New York",
        "state": "NY",
        "country": "USA",
        "person_company_name": "Acme Corp",
        "do_not_contact": false,
        "bouncing": false,
        "job_seniority": "manager",
        "custom_fields": \{
            "Lead Source": "Website",
            "Last Meeting": "2023-05-15"
        \},
        "tags": [
            "VIP",
            "Follow-up"
        ],
        "contact_restrictions": [
            "call"
        ],
        "counts": \{
            "emails_sent": 10,
            "emails_viewed": 8,
            "emails_clicked": 5,
            "emails_replied_to": 3,
            "emails_bounced": 0,
            "calls": 2
        \},
        "account": \{
            "id": 67890,
            "_href": "https://api.salesloft.com/v2/accounts/67890"
        \},
        "owner": \{
            "id": 54321,
            "_href": "https://api.salesloft.com/v2/users/54321"
        \}
    }
}

Update person stage

Updates a person stage. Sample Input Sample Output

{
    "data": \{
        "id": 12345,
        "name": "Qualified Lead",
        "created_at": "2023-05-15T10:30:00Z",
        "updated_at": "2023-05-20T14:45:00Z",
        "order": 2
    \}
}

Upsert person

Upserts a person record. Sample Input

{
    "access_token": "your_access_token_here",
    "fields": {
        "upsert_key": "email_address",
        "email_address": "john.doe@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "phone": "1234567890",
        "title": "Sales Manager",
        "city": "New York",
        "state": "NY",
        "country": "USA",
        "job_seniority": "manager",
        "do_not_contact": false,
        "tags": [
            "VIP",
            "High Priority"
        ],
        "contact_restrictions": [
            "call"
        ],
        "custom_fields": [
            \{
                "key": "Lead Source",
                "value": "Website"
            \},
            \{
                "key": "Last Meeting Date",
                "value": "2023-05-15"
            \}
        ],
        "account_id": 12345,
        "owner_id": 67890
    }
}

Sample Output

{
    "data": {
        "upsert_type": "created",
        "person": {
            "id": 987654,
            "created_at": "2023-05-20T10:30:00Z",
            "updated_at": "2023-05-20T10:30:00Z",
            "last_contacted_at": null,
            "last_replied_at": null,
            "first_name": "John",
            "last_name": "Doe",
            "display_name": "John Doe",
            "email_address": "john.doe@example.com",
            "full_email_address": "John Doe <john.doe@example.com>",
            "secondary_email_address": null,
            "personal_email_address": null,
            "phone": "1234567890",
            "phone_extension": null,
            "home_phone": null,
            "mobile_phone": null,
            "linkedin_url": null,
            "title": "Sales Manager",
            "city": "New York",
            "state": "NY",
            "country": "USA",
            "work_city": null,
            "work_state": null,
            "work_country": null,
            "crm_url": null,
            "crm_id": null,
            "crm_object_type": null,
            "owner_crm_id": null,
            "person_company_name": null,
            "person_company_website": null,
            "person_company_industry": null,
            "do_not_contact": "false",
            "bouncing": false,
            "locale": null,
            "eu_resident": false,
            "personal_website": null,
            "twitter_handle": null,
            "last_contacted_type": null,
            "job_seniority": "manager",
            "custom_fields": \{
                "Lead Source": "Website",
                "Last Meeting Date": "2023-05-15"
            \},
            "tags": [
                "VIP",
                "High Priority"
            ],
            "contact_restrictions": [
                "call"
            ],
            "counts": \{
                "emails_sent": 0,
                "emails_viewed": 0,
                "emails_clicked": 0,
                "emails_replied_to": 0,
                "emails_bounced": 0,
                "calls": 0
            \},
            "account": \{
                "_href": "/v2/accounts/12345",
                "id": 12345
            \},
            "owner": \{
                "_href": "/v2/users/67890",
                "id": 67890
            \},
            "last_contacted_by": null,
            "import": null,
            "person_stage": null,
            "most_recent_cadence": null,
            "last_completed_step_cadence": null,
            "last_completed_step": null
        }
    }
}

DDL operations

List account stages (DDL)

Sample Input

{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Sample Output

List account stages filter (DDL)

Sample Input Sample Output

List account tiers (DDL)

Sample Input

{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Sample Output

List accounts (DDL)

Sample Input

{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Sample Output

List accounts or people (DDL)

Sample Input Sample Output

{
    "options": [
        \{
            "label": "Accounts",
            "value": "accounts"
        \},
        \{
            "label": "People",
            "value": "people"
        \}
    ]
}

List actions (DDL)

Sample Input

{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Sample Output

List bulk jobs (DDL)

Sample Input Sample Output

List cadence memberships (DDL)

Sample Input

{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Sample Output

List cadences (DDL)

Sample Input Sample Output

List call data records (DDL)

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping


Sample Input Sample Output

List call dispositions (DDL)

Sample Input Sample Output

[
    \{
        "id": 1,
        "name": "Interested"
    \},
    \{
        "id": 2,
        "name": "Not Interested"
    \},
    \{
        "id": 3,
        "name": "No Answer"
    \},
    \{
        "id": 4,
        "name": "Left Voicemail"
    \},
    \{
        "id": 5,
        "name": "Wrong Number"
    \}
]

List call sentiments (DDL)

Sample Input Sample Output

List calls (DDL)

Sample Input Sample Output

List crm activities (DDL)

Sample Input Sample Output

{
    "crm_activities": [
        {
            "id": "act_123456",
            "type": "email",
            "subject": "Follow-up on proposal",
            "description": "Sent follow-up email regarding the proposal discussed last week",
            "created_at": "2023-05-15T10:30:00Z",
            "updated_at": "2023-05-15T10:30:00Z",
            "associated_with": \{
                "type": "contact",
                "id": "cont_789012"
            \},
            "owner": \{
                "id": "user_345678",
                "name": "Jane Smith"
            \}
        },
        {
            "id": "act_234567",
            "type": "call",
            "subject": "Initial discovery call",
            "description": "Conducted initial discovery call with potential client",
            "created_at": "2023-05-14T14:45:00Z",
            "updated_at": "2023-05-14T15:15:00Z",
            "associated_with": \{
                "type": "lead",
                "id": "lead_901234"
            \},
            "owner": \{
                "id": "user_456789",
                "name": "Mike Johnson"
            \}
        }
    ]
}

List crm activity fields (DDL)

Sample Input Sample Output

List custom fields (DDL)

Sample Input Sample Output

List custom fields value (DDL)

Sample Input Sample Output

List emails (DDL)

Sample Input Sample Output

List groups (DDL)

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping


Sample Input Sample Output

List imports (DDL)

Sample Input Sample Output

List locales (DDL)

Sample Input Sample Output

List notes (DDL)

Sample Input Sample Output

List people (DDL)

Sample Input

{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Sample Output

List person stages (DDL)

Sample Input Sample Output

List steps (DDL)

Sample Input Sample Output

List tags (DDL)

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping


Sample Input Sample Output

List tags values (DDL)

Sample Input

{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Sample Output

{
    "values": [
        \{
            "id": "tag_123",
            "name": "High Priority"
        \},
        \{
            "id": "tag_456",
            "name": "New Lead"
        \},
        \{
            "id": "tag_789",
            "name": "Follow Up"
        \},
        \{
            "id": "tag_101",
            "name": "Decision Maker"
        \},
        \{
            "id": "tag_202",
            "name": "Qualified"
        \}
    ]
}

List tasks (DDL)

Sample Input Sample Output

{}

List unlinked call data records (DDL)

Sample Input Sample Output

List users (DDL)

Sample Input Sample Output

{
    "columns": [
        \{
            "name": "id",
            "type": "integer"
        \},
        \{
            "name": "email",
            "type": "string"
        \},
        \{
            "name": "first_name",
            "type": "string"
        \},
        \{
            "name": "last_name",
            "type": "string"
        \},
        \{
            "name": "title",
            "type": "string"
        \},
        \{
            "name": "created_at",
            "type": "datetime"
        \},
        \{
            "name": "updated_at",
            "type": "datetime"
        \}
    ]
}

List users filter owners (DDL)

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping


Sample Input

{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Sample Output

{
    "users": [
        \{
            "id": 12345,
            "name": "John Smith",
            "email": "john.smith@example.com",
            "title": "Sales Manager"
        \},
        \{
            "id": 67890,
            "name": "Jane Doe",
            "email": "jane.doe@example.com",
            "title": "Account Executive"
        \},
        \{
            "id": 54321,
            "name": "Mike Johnson",
            "email": "mike.johnson@example.com",
            "title": "Sales Representative"
        \}
    ]
}

List users guid (DDL)

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping


Sample Input

{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Sample Output

{
    "users": [
        \{
            "id": "5f9b2b3c-1234-5678-90ab-cdef12345678",
            "name": "John Doe",
            "email": "john.doe@example.com",
            "guid": "usr_1a2b3c4d5e6f7g8h9i0j"
        \},
        \{
            "id": "6a7b8c9d-2345-6789-01cd-ef1234567890",
            "name": "Jane Smith",
            "email": "jane.smith@example.com",
            "guid": "usr_2b3c4d5e6f7g8h9i0j1k"
        \},
        \{
            "id": "7c8d9e0f-3456-7890-12ef-gh2345678901",
            "name": "Bob Johnson",
            "email": "bob.johnson@example.com",
            "guid": "usr_3c4d5e6f7g8h9i0j1k2l"
        \}
    ]
}

List users role ID (DDL)

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping


Sample Input

{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Sample Output

{
    "role_ids": [
        \{
            "id": "123456",
            "name": "Sales Representative"
        \},
        \{
            "id": "789012",
            "name": "Sales Manager"
        \},
        \{
            "id": "345678",
            "name": "Account Executive"
        \}
    ]
}

Was this page helpful?