Overview
Configuration is provided for establishing connections with Salesloft service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this guide, we will show you how to setup an OAuth Salesloft application.
Official documentation can be found here
Step 1: Go to your Account and click Your Applications.
Step 2: Once there click Create New next to the OAuth Applications text.
Step 3: Customize your application and don't forget to input "https://www.cozyroc.com/oauth_callback/" as your redirect URI.
Step 4: Click save and thats pretty much it.
In this task, we will show you step-by-step how to create a connection to Salesloft REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Salesloft. Then click New in the Token File parameter to create a new token file.
Step 3: Authenticate with your Salesloft account credentials.
Step 4: Save generated access token to file. Specify token protection password. Click OK.
Step 5. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Salesloft instance.
In this guide, we will show how to read data from the Salesloft service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 3. Double click on the "REST Source" component and select Salesloft connection from the combo. Select from available Salesloft resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select the Salesloft resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Salesloft service.
In this guide, we will show how to write data to the Salesloft service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Salesloft connection from the combo. Also, select resource action and the Salesloft resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Salesloft resource.
Configuration
Base URL address: https://api.salesloft.com/v2.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developers.salesloft.com/docs/platform/api-basics/oauth-authentication.
- [Read] action
-
Endpoint URL address:
/team.
The result is extracted from:{{=[response.data]}}.Documentation: https://developers.salesloft.com/docs/api/team-index.
- id
Data type: DT_I4
- team_template
Template: RefT. A read-only field.
- download_url
Template: LongText.
- attachment_file_size
Data type: DT_I4
- guid
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- name
Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- job_role
Template: ShortText.
- active
Data type: DT_BOOL
- time_zone
Template: ShortText.
- locale_utc_offset
Data type: DT_I4
- slack_username
Template: ShortText.
- twitter_handle
Template: ShortText.
Template: ShortText.
- email_client_email_address
Template: ShortText.
- sending_email_address
Template: ShortText.
- from_address
Template: ShortText.
- full_email_address
Template: ShortText.
- bcc_email_address
Template: ShortText.
- work_country
Template: ShortText.
- email_signature
Template: ShortText.
- email_signature_type
Template: ShortText.
- email_signature_click_tracking_disabled
Data type: DT_BOOL
- team_admin
Data type: DT_BOOL
- local_dial_enabled
Data type: DT_BOOL
- click_to_call_enabled
Data type: DT_BOOL
- email_client_configured
Data type: DT_BOOL
- crm_connected
Data type: DT_BOOL
- external_feature_flags
Template: LongText. A composite field.
- phone_client
Field components:
- Contains the following components: id.
- phone_number_assignment
Template: RefT. A read-only field.
- group
Template: RefT. A read-only field.
- team
Template: RefT. A read-only field.
- role
Template: RefT. A read-only field.
- group_privacy_setting
Template: ShortText.
- team_visibility_default
Template: ShortText.
- plan
Template: ShortText.
- plan_features
Field components:
-
Uses template:
ShortText. - Contains the following components: opportunity_management.
-
Uses template:
- license_limit
Data type: DT_I4
- record_by_default
Data type: DT_BOOL
- call_recording_disabled
Data type: DT_BOOL
- email_daily_limit
Data type: DT_I4
- click_tracking_default
Data type: DT_BOOL
- allow_automated_email_steps
Data type: DT_BOOL
- custom_tracking_domain
Template: ShortText.
- dispositions_required
Data type: DT_BOOL
- sentiments_required
Data type: DT_BOOL
- deactivated
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tags.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- search: Filters tags by name.
- ids: Example - 1, 5, 9
Documentation: https://developers.salesloft.com/docs/api/tags-index.
- id
Data type: DT_I4
- name
Template: ShortText.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/accounts.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- tag: Example - important, lucrative
- ids: Example - 3534, 234234
- crm_id: Example - 0030H000050qeeM, 0234sDHH34
- domain: Domain of the accounts to fetch. Domains are unique and lowercase
- name: Names of accounts to fetch. Name matches are exact and case insensitive. Multiple names can be fetched.
- city: Example - Atlanta
Documentation: https://developers.salesloft.com/docs/api/accounts-index.
- [Create] action
-
Endpoint URL address:
/accounts.Documentation: https://developers.salesloft.com/docs/api/accounts-create.
- [Update] action
-
Endpoint URL address:
/accounts/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/accounts-update.
- [Delete] action
-
Endpoint URL address:
/accounts/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/accounts-destroy.
- id
A key field. Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- archived_at
Template: DateTime. A read-only field.
- name
Template: ShortText.
- domain
Template: ShortText.
- conversational_name
Template: ShortText.
- description
Template: ShortText.
- phone
Template: ShortText.
- website
Template: ShortText.
- linkedin_url
Template: ShortText.
- twitter_handle
Template: ShortText.
- street
Template: ShortText.
- city
Template: ShortText.
- state
Template: ShortText.
- postal_code
Template: ShortText.
- country
Template: ShortText.
- locale
Template: ShortText.
- industry
Template: ShortText.
- company_type
Template: ShortText.
- founded
Template: ShortText.
- revenue_range
Template: ShortText.
- size
Template: ShortText.
- crm_id
Template: ShortText.
- crm_url
Template: ShortText.
- crm_object_type
Template: ShortText.
- account_tier_id
Template: ShortText.
- owner_id
Template: ShortText.
- owner_crm_id
Template: ShortText.
- crm_id_type
Template: ShortText.
- last_contacted_at
Template: DateTime. A read-only field.
- last_contacted_type
Template: ShortText.
- do_not_contact
Data type: DT_BOOL
- archived
Data type: DT_BOOL
- custom_fields
Field components:
-
Uses template:
ShortText. - Contains the following components: MyField, Other.
-
Uses template:
- user_relationships
Field components:
-
Uses template:
ShortText. - Contains the following components: bff, Other.
-
Uses template:
- tags
Template: LongText. A composite field.
- counts
Field components:
- Contains the following components: people.
- owner
Template: RefT. A read-only field.
- creator
Template: RefT. A read-only field.
- last_contacted_by
Template: RefT. A read-only field.
- last_contacted_person
Template: RefT. A read-only field.
- company_stage
Template: RefT. A read-only field.
- account_tier
Template: RefT. A read-only field.
- order
Data type: DT_I4
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/account_stages.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: Example - 1, 5, 9
Documentation: https://developers.salesloft.com/docs/api/account-stages-index.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- order
Data type: DT_I4
- active
Data type: DT_BOOL
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/account_tiers.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: Example - 1, 5, 9
- name: Example - Low Tier, High Tier
Documentation: https://developers.salesloft.com/docs/api/account-tiers-index.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- order
Data type: DT_I4
- active
Data type: DT_BOOL
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/actions.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- type: Filter actions by type
- ids: Example - 1, 5, 9
Documentation: https://developers.salesloft.com/docs/api/actions-index.
- [Create] action
-
Endpoint URL address:
/ongoing_actions.Documentation: https://developers.salesloft.com/docs/api/ongoing-actions-create.
- id
Data type: DT_I4 A read-only field.
- action_id
Data type: DT_I4
- due
Data type: DT_BOOL A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- type
Template: ShortText. A read-only field.
- status
Template: ShortText. A read-only field.
- due_on
Template: DateTime. A read-only field.
- multitouch_group_id
Data type: DT_I4 A read-only field.
- action_details
Template: RefT. A read-only field.
- user
Template: RefT. A read-only field.
- person
Template: RefT. A read-only field.
- cadence
Template: RefT. A read-only field.
- step
Template: RefT. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/activity_histories.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- type: Filter by the type of activity.
- resource_type: Filter by the resource type.
Documentation: https://developers.salesloft.com/docs/api/activity-histories-index.
- [Create] action
-
Endpoint URL address:
/activities.Documentation: https://developers.salesloft.com/docs/api/activities-create.
- id
A key field. Template: ShortText. A read-only field.
- action_id
Data type: DT_I4
- task_id
Data type: DT_I4
- user_guid
Template: ShortText. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- type
Template: ShortText. A read-only field.
- static_data
A read-only field. Field components:
- Contains the following components: email_id.
- resource_type
Template: ShortText. A read-only field.
- resource_id
Data type: DT_I4 A read-only field.
- pinned_at
Template: DateTime. A read-only field.
- occurred_at
Template: DateTime. A read-only field.
- failed_dynamic_resources
Template: LongText. A read-only field. A composite field.
- dynamic_data
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: subject, status, counts.
-
Uses template:
- created_at
Template: DateTime. A read-only field.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/bulk_jobs.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- state: The state of the bulk job. Accepts multiple states. Each state must be one of: open, executing, done
- id: Filter by id using comparison operators. Only supports greater than (gt) comparison (i.e. id[gt]=123)
Documentation: https://developers.salesloft.com/docs/api/bulk-jobs-index.
- [Create] action
-
Endpoint URL address:
/bulk_jobs.Documentation: https://developers.salesloft.com/docs/api/bulk-jobs-create.
- [Update] action
-
Endpoint URL address:
/bulk_jobs/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/bulk-jobs-update.
- id
A key field. Data type: DT_I4
- updated_at
Template: DateTime.
- type
Template: ShortText.
- total
Data type: DT_I4
- state
Template: ShortText.
- started_at
Template: DateTime.
- scopes
Template: LongText. A composite field.
- ready_to_execute
Data type: DT_BOOL
- processed
Data type: DT_I4
- name
Template: ShortText.
- marked_ready_at
Template: DateTime.
- finished_at
Template: DateTime.
- errors
Data type: DT_I4
- created_at
Template: DateTime.
- [Read] action
-
Endpoint URL address:
/bulk_jobs/{{=parameters.id}}/job_data.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- id: Required. The id for the bulk job to which the job data relates.
- state: The state of the bulk job. Accepts multiple states. Each state must be one of: open, executing, done
The following request parameters will be automatically processed:
-
per_page:
{{=parameters.batchSize}}
Documentation: https://developers.salesloft.com/docs/api/bulk-jobs-job-data-index.
- [Read completed] action
-
Endpoint URL address:
/bulk_jobs/{{=parameters.id}}/results.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- id: Required. The id for the Bulk Job.
- status: Filter by result status.
The following request parameters will be automatically processed:
-
per_page:
{{=parameters.batchSize}}
Documentation: https://developers.salesloft.com/docs/api/bulk-jobs-job-data-index.
- [Create] action
-
Endpoint URL address:
/bulk_jobs/{{=item.bulk_jobs_id}}/job_data.Documentation: https://developers.salesloft.com/docs/api/bulk-jobs-job-data-create.
The resource includes the fields from the BulkJobDataT template.
- bulk_jobs_id
Data type: DT_I4
- data
Template: LongText. A composite field.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/cadences.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of cadence memberships to fetch.
- tag_ids: Filters by tags.
- archived: Filters by whether the Cadences have been archived.
Documentation: https://developers.salesloft.com/docs/api/cadences-index.
- [Create] action
-
Endpoint URL address:
/cadence_imports.Documentation: https://developers.salesloft.com/docs/api/cadence-imports-create.
- id
A key field. Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- archived_at
Template: DateTime. A read-only field.
- latest_active_date
Data type: DT_DATE
- team_cadence
Data type: DT_BOOL
- shared
Data type: DT_BOOL
- remove_bounces_enabled
Data type: DT_BOOL
- remove_replies_enabled
Data type: DT_BOOL
- opt_out_link_included
Data type: DT_BOOL
- draft
Data type: DT_BOOL
- override_contact_restrictions
Data type: DT_BOOL
- cadence_framework_id
Data type: DT_I4
- cadence_function
Template: ShortText.
- sharing_settings
Template: LongText. A composite field.
- settings
Template: LongText. A composite field.
- name
Template: ShortText.
- external_identifier
Template: ShortText.
- tags
Template: LongText. A composite field.
- creator
Template: RefT. A read-only field.
- owner
Template: RefT. A read-only field.
- bounced_stage
Template: RefT. A read-only field.
- replied_stage
Template: RefT. A read-only field.
- added_stage
Template: RefT. A read-only field.
- finished_stage
Template: RefT. A read-only field.
- cadence_priority
Template: RefT. A read-only field.
- groups
Field components:
- An array.
-
Uses template:
RefT.
- counts
Field components:
- Contains the following components: cadence_people, people_acted_on_count, target_daily_people, opportunities_created, meetings_booked.
- cadence_content
Template: LongText. A composite field. The value is gathered from
/cadence_exports/{{=item.id}}address. The gathered value is processed with{{=response.data.cadence_content}}expression.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/cadence_memberships.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of cadence memberships to fetch.
- person_id: ID of the person to find cadence memberships for.
- cadence_id: ID of the person to find cadence memberships for.
Documentation: https://developers.salesloft.com/docs/api/cadence-memberships-index.
- [Create] action
-
Endpoint URL address:
/cadence_memberships.Documentation: https://developers.salesloft.com/docs/api/cadence-memberships-create.
- [Delete] action
-
Endpoint URL address:
/cadence_memberships/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/cadence-memberships-destroy.
- id
A key field. Data type: DT_I4
- added_at
Template: DateTime. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- person_deleted
Data type: DT_BOOL
- currently_on_cadence
Data type: DT_BOOL
- current_state
Template: ShortText.
- cadence_id
Template: ShortText.
- cadence
Template: RefT. A read-only field.
- person_id
Template: ShortText.
- person
Template: RefT. A read-only field.
- user_id
Template: ShortText.
- user
Template: RefT. A read-only field.
- latest_action
Field components:
- Contains the following components: id.
- step_id
Template: ShortText.
- counts
Field components:
- Contains the following components: views, clicks, replies, calls, sent_emails, bounces.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/calendar/events.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- calendar_id: Id of the user who created or included as a guest to the event.
- start_time: Lower bound (inclusive) for a calendar event's end time to filter by. Must be in ISO 8601 format. Example: 2022-02-14T10:12:59+00:00.
- end_time: Upper bound (exclusive) for a calendar event's start time to filter by. Must be in ISO 8601 format. Example: 2022-02-14T10:12:59+00:00.
Documentation: https://developers.salesloft.com/docs/api/calendar-events-index.
- [Upsert] action
-
Endpoint URL address:
/calendar/events/upsert.
The action uses POST method.Documentation: https://developers.salesloft.com/docs/api/calendar-events-upsert-create/.
- id
A key field. Template: ShortText.
- upsert_key
Template: LongText. A composite field.
- user_guid
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
- title
Template: ShortText.
- tenant_id
Data type: DT_I4
- status
Template: ShortText.
- start_time
Template: DateTime.
- recurring_interval
Template: ShortText.
- recurring
Data type: DT_BOOL
- recurrence
Template: LongText. A composite field.
- provider
Template: ShortText.
- organizer
Template: ShortText.
- location
Template: ShortText.
- last_occurrence_at
Template: DateTime.
- i_cal_uid
Template: ShortText.
- html_link
Template: ShortText.
- extended_properties
Template: LongText. A composite field.
- end_time
Template: DateTime.
- description
Template: ShortText.
- creator
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- conference_data
Template: LongText. A composite field.
- canceled_at
Template: DateTime.
- calendar_id
Template: ShortText.
- busy
Data type: DT_BOOL
- body_html
Template: ShortText.
- attendees
Field components:
- An array.
- Contains the following components: status_changed, status, organizer, name, email, deleted_at.
- all_day
Data type: DT_BOOL
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/call_data_records.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of call data records to fetch.
- person_id: Filters list by person_id.
- status: Filters by specified status.
- direction: Filters by specified direction (inbound or outbound).
- disposition: Filters by specified disposition. Example: Any disposition saved by your team.
- group_id: Filters list by group id.
Documentation: https://developers.salesloft.com/docs/api/call-data-records-index.
- id
A key field. Data type: DT_I4
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- to
Template: ShortText.
- from
Template: ShortText.
- duration
Data type: DT_I4
- direction
Template: ShortText.
- status
Template: ShortText.
- call_type
Template: ShortText.
- call_uuid
Template: ShortText.
- recording
Field components:
-
Uses template:
ShortText. - Contains the following components: url, status, recording_status.
-
Uses template:
- dialer_recording
Template: RefT. A read-only field.
- call
Template: RefT. A read-only field.
- user
Template: RefT. A read-only field.
- called_person
Template: RefT. A read-only field.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/activities/calls.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of calls to fetch.
- person_id: Filters calls by person_id.
Documentation: https://developers.salesloft.com/docs/api/activities-calls-index.
- [Create] action
-
Endpoint URL address:
/activities/calls.Documentation: https://developers.salesloft.com/docs/api/activities-calls-index.
- id
A key field. Data type: DT_I4
- person_id
Data type: DT_I4
- to
Template: ShortText.
- duration
Data type: DT_I4
- sentiment
Template: ShortText.
- instructions
Template: ShortText.
- name
Template: ShortText.
- notes
Template: ShortText.
- user_guid
Template: ShortText.
- action_id
Data type: DT_I4
- task_id
Data type: DT_I4
- crm_params
Template: LongText. A composite field.
- crm_activity_metadata
Template: LongText. A composite field.
- linked_call_data_record_ids
Template: ShortText. An array field.
- disposition
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- recordings
Field components:
- An array.
- Contains the following components: url, recording_status, status.
- user
Template: RefT. A read-only field.
- called_person
Template: RefT. A read-only field.
- crm_activity
Template: RefT. A read-only field.
- note
Template: RefT. A read-only field.
- cadence
Template: RefT. A read-only field.
- step
Template: RefT. A read-only field.
- action
Field components:
- Contains the following components: create_conversation_call.
- [Read] action
-
Endpoint URL address:
/phone_numbers/caller_ids.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- phone_number: Required. Phone Number in E.164 format. Example: +17705550212
Documentation: https://developers.salesloft.com/docs/api/phone-numbers-caller-ids-index.
- display_name
Template: ShortText.
- title
Template: ShortText.
- account_name
Template: ShortText.
- person
Template: RefT. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/call_sentiments.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- name: Filters call sentiments by name.
Documentation: https://developers.salesloft.com/docs/api/call-sentiments-index.
- id
A key field. Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- name
Template: LongText.
Based on resource template WithSingle.
- [Read Call instructions] action
-
Endpoint URL address:
/action_details/call_instructions.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of call instructions to fetch.
Documentation: https://developers.salesloft.com/docs/api/action-details-call-instructions-index.
- id
A key field. Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- instructions
Template: LongText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/call_dispositions.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
Documentation: https://developers.salesloft.com/docs/api/call-dispositions-index.
- id
A key field. Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- name
Template: LongText.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/conversations.
The result is extracted from:{{=response.data}}.Documentation: https://developers.salesloft.com/docs/api/conversations-find-all/.
- id
A key field. Template: ShortText.
- duration
Data type: DT_I4
- is_api
Data type: DT_BOOL
- platform
Template: ShortText.
- media_type
Template: ShortText.
- organization_id
Template: ShortText.
- user_guid
Template: ShortText.
- started_recording_at
Data type: DT_I4
- event_end_date
Template: DateTime.
- event_start_date
Template: DateTime.
- language_code
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- account
Template: RefT. A read-only field.
- person
Template: RefT. A read-only field.
- recording
Template: RefT. A read-only field.
- transcription
Template: RefT. A read-only field.
- transcription_sentences
Template: RefT. A read-only field.
- transcription_artifact
Template: RefT. A read-only field.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/crm_activities.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of crm activities to fetch.
Documentation: https://developers.salesloft.com/docs/api/crm-activities-index/.
- id
A key field. Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- subject
Template: ShortText.
- description
Template: ShortText.
- crm_id
Template: ShortText.
- activity_type
Template: ShortText.
- error
Template: ShortText.
- custom_crm_fields
Field components:
-
Uses template:
ShortText. - Contains the following components: ecorp__Call_Type__c.
-
Uses template:
- person
Template: RefT. A read-only field.
- user
Template: RefT. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/crm_activity_fields.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- source: Return only records with this source.
Documentation: https://developers.salesloft.com/docs/api/crm-activity-fields-index.
- id
A key field. Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- title
Template: ShortText.
- salesforce_object_type
Template: ShortText.
- crm_object_type
Template: ShortText.
- source
Template: ShortText.
- field
Template: ShortText.
- field_type
Template: ShortText.
- value
Template: ShortText.
- picklist_values
Field components:
-
Uses template:
ShortText. - Contains the following components: High, Low.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/crm_users.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of crm users to fetch.
- crm_id: Filters crm users by crm_ids.
- user_id: Filters crm users by user_ids.
- search: List of keywords used to find case-insensitive substring matches against account First Name, Last Name.
Documentation: https://developers.salesloft.com/docs/api/crm-users-index.
- id
A key field. Data type: DT_I4
- crm_id
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- name
Template: ShortText.
- user
Template: RefT. A read-only field.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/custom_fields.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of custom fields to fetch.
- field_type: Type of field to fetch.
Documentation: https://developers.salesloft.com/docs/api/custom-fields-index.
- [Create] action
-
Endpoint URL address:
/custom_fields.Documentation: https://developers.salesloft.com/docs/api/custom-fields-create.
- [Delete] action
-
Endpoint URL address:
/custom_fields/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/custom-fields-destroy.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- field_type
Template: ShortText.
- value_type
Template: ShortText. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/custom_roles.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of roles to fetch.
Documentation: https://developers.salesloft.com/docs/api/custom-roles-index.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/activities/emails.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of emails to fetch.
- crm_activity_id: Filters emails by crm_activity_id.
- action_id: Filters emails by action_id.
- status: Filters emails by status.
Documentation: https://developers.salesloft.com/docs/api/activities-emails-index.
- [Read pending] action
-
Endpoint URL address:
/pending_emails.
The result is extracted from:{{=response.data}}.Documentation: https://developers.salesloft.com/docs/api/pending-emails-index.
- [Create] action
-
Endpoint URL address:
/external_emails.The following request parameters will be automatically processed:
-
application/json:
{{=_.extend(item.mime_content, {mailbox: item.mailbox}) }}
Documentation: https://developers.salesloft.com/docs/api/external-emails-create.
-
application/json:
- id
A key field. Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- recipient_email_address
Template: ShortText. A read-only field.
- status
Template: ShortText. A read-only field.
- bounced
Data type: DT_BOOL A read-only field.
- send_after
Template: DateTime. A read-only field.
- sent_at
Template: DateTime. A read-only field.
- view_tracking
Data type: DT_BOOL A read-only field.
- click_tracking
Data type: DT_BOOL A read-only field.
- headers
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: cc, bcc.
-
Uses template:
- personalization
Template: ShortText. A read-only field.
- subject
Template: ShortText. A read-only field.
- body
Template: LongText. A read-only field.
- error_message
Template: ShortText. A read-only field.
- draft_with_ai
Data type: DT_BOOL A read-only field.
- counts
A read-only field. Field components:
- Contains the following components: clicks, views, replies, unique_devices, unique_locations, attachments.
- user
Template: RefT. A read-only field.
- recipient
Template: RefT. A read-only field.
- mailing
A read-only field. Field components:
- Contains the following components: id.
- action
A read-only field. Field components:
- Contains the following components: id.
- task
A read-only field. Field components:
- Contains the following components: id.
- crm_activity
Template: RefT. A read-only field.
- cadence
Template: RefT. A read-only field.
- step
Template: RefT. A read-only field.
- email_template
Template: RefT. A read-only field.
- additional_recipients
Field components:
- An array.
-
Uses template:
RefT.
- mailbox
Template: ShortText.
- mime_email_payload
Template: RefT. A read-only field.
- mime_content
The value is gathered from
/mime_email_payloads/{{=item.id}}address. Field components:-
Uses template:
ShortText. - Contains the following components: mailbox, message_id, raw.
-
Uses template:
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/email_templates.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of email templates to fetch.
- search: Filters email templates by title or subject.
- tag: Filters email templates by tags applied to the template, not to exceed 100 tags.
- group_id: Filters email templates by groups applied to the template by group ID.
- cadence_id: Filters email templates to those belonging to the cadence.
Documentation: https://developers.salesloft.com/docs/api/email-templates-index.
- [Create] action
-
Endpoint URL address:
/email_templates.Documentation: https://developers.salesloft.com/docs/api/email-templates-create/.
- [Update] action
-
Endpoint URL address:
/email_templates/{{=parameters.id}}.Documentation: https://developers.salesloft.com/docs/api/email-templates-update/.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- subject
Template: ShortText.
- body
Template: LongText.
- body_preview
Template: ShortText. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- last_used_at
Template: DateTime. A read-only field.
- archived_at
Template: DateTime. A read-only field.
- shared
Data type: DT_BOOL A read-only field.
- open_tracking
Data type: DT_BOOL
- open_tracking_enabled
Data type: DT_BOOL A read-only field.
- click_tracking
Data type: DT_BOOL
- click_tracking_enabled
Data type: DT_BOOL A read-only field.
- cadence_template
Data type: DT_BOOL A read-only field.
- counts
A read-only field. Field components:
- Contains the following components: sent_emails, views, clicks, replies, bounces.
- template_owner
Template: RefT. A read-only field.
- team_template
Template: RefT. A read-only field.
- _links
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: attachments.
-
Uses template:
- tags
Template: LongText. A read-only field. A composite field.
- groups
A read-only field. Field components:
- An array.
-
Uses template:
RefT.
- attachment_ids
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/email_template_attachments.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of email template attachments to fetch.
- email_template_id: Filters email template attachments by email template IDs.
Documentation: https://developers.salesloft.com/docs/api/email-templates-index.
- id
A key field. Data type: DT_I4
- attachment_id
Data type: DT_I4 A read-only field.
- email_template
Template: RefT. A read-only field.
- name
Template: ShortText. A read-only field.
- download_url
Template: ShortText. A read-only field.
- attachment_file_size
Data type: DT_I4 A read-only field.
- scanned
Data type: DT_BOOL A read-only field.
- attachment_content_type
Template: ShortText. A read-only field.
- attachment_fingerprint
Data type: DT_I4 A read-only field.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/groups.
The result is extracted from:{{=response.data}}.
The result is paginated.The action has the following user-defined parameters:
- ids: Group IDs.
Documentation: https://developers.salesloft.com/docs/api/groups-index.
- [Create] action
-
Endpoint URL address:
/groups.Documentation: https://developers.salesloft.com/docs/api/groups-create.
- [Update] action
-
Endpoint URL address:
/groups/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/groups-update.
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/groups-destroy.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- parent_id
Data type: DT_I4
- accessible_groups
A read-only field. Field components:
- An array.
-
Uses template:
RefT.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/imports.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of imports to fetch.
- user_ids: ID of users to fetch imports for.
- import_type: Filter imports by import type or import types.
- name: Names of imports to fetch, name matches are partial and case insensitive.
Documentation: https://developers.salesloft.com/docs/api/imports-index.
- [Create] action
-
Endpoint URL address:
/imports.Documentation: https://developers.salesloft.com/docs/api/imports-create.
- [Update] action
-
Endpoint URL address:
/imports/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/imports-update.
- [Delete] action
-
Endpoint URL address:
/imports/{{=item.id}}.The following request parameters will be automatically processed:
-
undo:
{{=item.undo}}
Documentation: https://developers.salesloft.com/docs/api/imports-destroy.
-
undo:
- id
A key field. Data type: DT_I4
- undo
Template: ShortText.
- user_id
Template: ShortText.
- name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- current_people_count
Data type: DT_I4
- imported_people_count
Data type: DT_I4
- errors_list
Field components:
- An array.
- Contains the following components: errors, params.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/third_party_live_feed_items.Documentation: https://developers.salesloft.com/docs/api/third-party-live-feed-items-create.
- user_guid
Template: ShortText.
- subject_type
Template: ShortText.
- subject_id
Data type: DT_I4
- message
Template: ShortText.
- idempotency_key
Template: ShortText.
- event_occurred_at
Field components:
-
Uses template:
ShortText. - Contains the following components: gt, gte, lt, lte.
-
Uses template:
- action
Field components:
- Contains the following components: create_live_website_tracking_parameter.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/meetings.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of meetings to fetch.
- status: Filters meetings by status.
- person_id: Filters meetings by person_id.
- show_deleted: Flag to show only canceled events in the results when set to 'true'.
Documentation: https://developers.salesloft.com/docs/api/meetings-index.
- [Update] action
-
Endpoint URL address:
/meetings/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/meetings-update.
- id
A key field. Data type: DT_I4
- reschedule_link
Template: ShortText.
- title
Template: ShortText.
- start_time
Template: DateTime.
- end_time
Template: DateTime.
- calendar_id
Template: ShortText.
- calendar_type
Template: ShortText.
- meeting_type_id
Template: ShortText.
- meeting_type
Template: ShortText.
- recipient_name
Template: ShortText.
- recipient_email
Template: ShortText.
- location
Template: ShortText.
- description
Template: ShortText.
- event_id
Template: ShortText.
- account_id
Template: ShortText.
- task_id
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- guests
Template: LongText. A composite field.
- attendees
Field components:
- An array.
- Contains the following components: status, organizer, name, email, deleted_at.
- person
Template: RefT. A read-only field.
- cadence
Template: RefT. A read-only field.
- step
Template: RefT. A read-only field.
- owned_by_user
Template: RefT. A read-only field.
- booked_by_user
Template: RefT. A read-only field.
- crm_references
Field components:
- Contains the following components: who, what.
- event_source
Template: ShortText.
- canceled_at
Template: ShortText.
- all_day
Data type: DT_BOOL
- no_show
Data type: DT_BOOL
- crm_custom_fields
Field components:
-
Uses template:
ShortText. - Contains the following components: Event_Calendar_Type__c.
-
Uses template:
- strict_attribution
Data type: DT_BOOL
- i_cal_uid
Template: ShortText.
- status
Template: ShortText.
- reschedule_status
Template: ShortText.
- owned_by_meetings_settings
Field components:
-
Uses template:
ShortText. - Contains the following components: email_address.
-
Uses template:
- booked_by_meetings_settings
Field components:
-
Uses template:
ShortText. - Contains the following components: email_address.
-
Uses template:
- reschedule_guid
Template: ShortText.
- recurring
Data type: DT_BOOL
- recurrence
Template: LongText. A composite field.
- recurring_interval
Template: ShortText.
- last_occurrence_at
Template: ShortText.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/notes.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of notes to fetch.
- associated_with_type: Case insensitive type of item with which the note is associated.
- associated_with_id: ID of the item with which the note is associated.
Documentation: https://developers.salesloft.com/docs/api/notes-index.
- [Create] action
-
Endpoint URL address:
/notes.Documentation: https://developers.salesloft.com/docs/api/notes-create.
- [Update] action
-
Endpoint URL address:
/notes/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/groups-update.
- [Delete] action
-
Endpoint URL address:
/notes/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/notes-destroy.
- id
A key field. Data type: DT_I4
- content
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- associated_type
Template: ShortText.
- associated_with_type
Template: ShortText.
- associated_with_id
Data type: DT_I4
- skip_crm_sync
Data type: DT_BOOL
- call_id
Data type: DT_I4
- subject
Template: ShortText.
- user_guid
Template: ShortText.
- user
Template: RefT. A read-only field.
- associated_with
Template: RefT. A read-only field.
- call
Template: RefT. A read-only field.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/people.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of people to fetch.
- email_addresses: Filters people by email address.
- crm_id: Filters people by crm_id. Multiple crm ids can be applied.
- tag_id: Filters people by the tag ids applied to the person. Multiple tag ids can be applied.
Documentation: https://developers.salesloft.com/docs/api/people-index.
- [Create] action
-
Endpoint URL address:
/people.Documentation: https://developers.salesloft.com/docs/api/people-create.
- [Update] action
-
Endpoint URL address:
/people/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/people-update.
- [Upsert] action
-
Endpoint URL address:
/person_upserts.
The action uses POST method.Documentation: https://developers.salesloft.com/docs/api/person-upserts-create.
- [Delete] action
-
Endpoint URL address:
/people/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/people-destroy.
- id
A key field. Data type: DT_I4
- upsert_key
Template: ShortText.
- account_id
Data type: DT_I4
- owner_id
Data type: DT_I4
- import_id
Data type: DT_I4
- person_stage_id
Data type: DT_I4
- crm_id_type
Template: ShortText.
- autotag_date
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- last_contacted_at
Template: DateTime.
- last_replied_at
Template: DateTime.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- display_name
Template: ShortText.
- email_address
Template: ShortText.
- full_email_address
Template: ShortText.
- secondary_email_address
Template: ShortText.
- personal_email_address
Template: ShortText.
- phone
Template: ShortText.
- phone_extension
Template: ShortText.
- home_phone
Template: ShortText.
- mobile_phone
Template: ShortText.
- linkedin_url
Template: ShortText.
- title
Template: ShortText.
- city
Template: ShortText.
- state
Template: ShortText.
- country
Template: ShortText.
- work_city
Template: ShortText.
- work_state
Template: ShortText.
- work_country
Template: ShortText.
- crm_url
Template: ShortText.
- crm_id
Template: ShortText.
- crm_object_type
Template: ShortText.
- owner_crm_id
Template: ShortText.
- person_company_name
Template: ShortText.
- person_company_website
Template: ShortText.
- person_company_industry
Template: ShortText.
- do_not_contact
Data type: DT_BOOL
- bouncing
Data type: DT_BOOL
- locale
Template: ShortText.
- locale_utc_offset
Data type: DT_I4
- eu_resident
Data type: DT_BOOL
- personal_website
Template: ShortText.
- twitter_handle
Template: ShortText.
- last_contacted_type
Template: ShortText.
- job_seniority
Template: ShortText.
- custom_fields
Template: ShortText. A composite field.
- tags
Template: LongText. A composite field.
- contact_restrictions
Template: LongText. A composite field.
- success_count
Data type: DT_I4
- starred
Data type: DT_BOOL
- untouched
Data type: DT_BOOL
- counts
Field components:
- Contains the following components: emails_sent, emails_viewed, emails_clicked, emails_replied_to, emails_bounced, calls.
- account
Template: RefT. A read-only field.
- owner
Template: RefT. A read-only field.
- last_contacted_by
Template: RefT. A read-only field.
- import
Template: RefT. A read-only field.
- person_stage
Template: RefT. A read-only field.
- most_recent_cadence
Template: RefT. A read-only field.
- last_completed_step_cadence
Template: RefT. A read-only field.
- last_completed_step
Template: RefT. A read-only field.
- cadences
A read-only field. Field components:
- An array.
-
Uses template:
RefT.
- action
Field components:
- Contains the following components: soft_delete.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/person_stages.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of person stages to fetch.
- active: Flag signalizing whether the fetched Person Stages should be active.
Documentation: https://developers.salesloft.com/docs/api/person-stages-index.
- [Create] action
-
Endpoint URL address:
/person_stages.Documentation: https://developers.salesloft.com/docs/api/person-stages-create.
- [Update] action
-
Endpoint URL address:
/person_stages/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/person-stages-update.
- [Delete] action
-
Endpoint URL address:
/person_stages/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/person-stages-destroy.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- order
Data type: DT_I4
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/phone_number_assignments.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of phone number assignments to fetch.
Documentation: https://developers.salesloft.com/docs/api/phone-number-assignments-index.
- id
A key field. Data type: DT_I4
- number
Template: ShortText.
- user
Template: RefT. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/phone_numbers/recording_settings/{{=parameters.id}}.
The result is extracted from:{{=[response.data]}}.The action has the following user-defined parameters:
- id: Required. PhoneNumberAssignment ID
Documentation: https://developers.salesloft.com/docs/api/phone-number-assignments-show.
- recording_default
Data type: DT_BOOL
- parties_to_record
Template: ShortText.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/data_control/requests.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- team_id: Internal Use Only.
- request_type: Standardized type of the Request.
- dry_run: Whether or not the Request was a dry run.
Documentation: https://developers.salesloft.com/docs/api/data-control-requests-index.
- id
A key field. Data type: DT_I4
- user_guid
Template: ShortText.
- team_id
Data type: DT_I4
- request_type
Template: ShortText.
- metadata
Field components:
-
Uses template:
LongText. - Contains the following components: people_ids.
-
Uses template:
- events
Template: LongText. A composite field.
- dry_run
Data type: DT_BOOL
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/data_control/right_to_be_forgotten.Documentation: https://developers.salesloft.com/docs/api/data-control-right-to-be-forgotten-create.
- team_id
Data type: DT_I4
- schedule
Field components:
-
Uses template:
ShortText. - Contains the following components: time_of_day, initial_date, recurrence.
-
Uses template:
- people_ids
Template: LongText. A composite field.
- dry_run
Data type: DT_BOOL
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/saved_list_views.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: Filter by the type of activity.
- view: Type of saved list views to fetch.
- shared: Whether the view is shared or not.
- include_shared: Whether including shared views or not.
Documentation: https://developers.salesloft.com/docs/api/saved-list-views-index.
- [Create] action
-
Endpoint URL address:
/saved_list_views.Documentation: https://developers.salesloft.com/docs/api/saved-list-views-create.
- [Update] action
-
Endpoint URL address:
/saved_list_views/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/saved-list-views-update.
- [Delete] action
-
Endpoint URL address:
/saved_list_views/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/saved-list-views-destroy.
- id
A key field. Data type: DT_I4
- view
Template: ShortText.
- name
Template: ShortText.
- view_params
Field components:
-
Uses template:
ShortText. - Contains the following components: owner, stage, unowned.
-
Uses template:
- is_default
Data type: DT_BOOL A read-only field.
- shared
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/meetings/settings/searches.
The result is extracted from:{{=response.data}}.
The action uses POST method.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- user_guids: Filters meeting settings by array of user_guids.
Documentation: https://developers.salesloft.com/docs/api/meetings-settings-searches-create/.
- [Update] action
-
Endpoint URL address:
/meetings/settings/searches/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/meetings-settings-update.
- id
A key field. Data type: DT_I4
- user
Template: RefT. A read-only field.
- user_slug
Template: ShortText.
- primary_calendar_id
Template: ShortText.
- primary_calendar_name
Template: ShortText.
- email_address
Template: ShortText.
- user_details
Field components:
-
Uses template:
ShortText. - Contains the following components: name, email.
-
Uses template:
- calendar_type
Template: ShortText.
- title
Template: ShortText.
- description
Template: ShortText.
- location
Template: ShortText.
- default_meeting_length
Data type: DT_I4
- availability_limit_enabled
Data type: DT_BOOL
- availability_limit
Data type: DT_I4
- schedule_delay
Data type: DT_I4
- buffer_time_duration
Data type: DT_I4
- schedule_buffer_enabled
Data type: DT_BOOL
- times_available
Field components:
- Contains the following components: monday.
- allow_booking_on_behalf
Data type: DT_BOOL
- allow_booking_overtime
Data type: DT_BOOL
- allow_event_overlap
Data type: DT_BOOL
- share_event_detail
Data type: DT_BOOL
- enable_dynamic_location
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- time_zone
Template: ShortText.
- primary_calendar_connection_failed
Data type: DT_BOOL
- enable_calendar_sync
Data type: DT_BOOL
- reschedule_meetings_enabled
Data type: DT_BOOL
- active_meeting_url
Field components:
-
Uses template:
ShortText. - Contains the following components: url, created_at, updated_at.
-
Uses template:
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/integrations/signals/registrations.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- type: Types of signal registrations to fetch.
Documentation: https://developers.salesloft.com/docs/api/integrations-signals-registrations-index.
- [Create] action
-
Endpoint URL address:
/integrations/signals/registrations.Documentation: https://developers.salesloft.com/docs/api/integrations-signals-registrations-create.
- [Update] action
-
Endpoint URL address:
/integrations/signals/registrations/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/integrations-signals-registrations-update.
- [Delete] action
-
Endpoint URL address:
/integrations/signals/registrations/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/integrations-signals-registrations-destroy.
- id
A key field. Data type: DT_I4
- integration_id
Data type: DT_I4
- type
Template: ShortText.
- owner_user_guid
Template: ShortText.
- integration_slug
Template: ShortText.
- integration
Template: RefT. A read-only field.
- indicators
Field components:
- An array.
- Contains the following components: metadata_shape, key, description.
- globally_installed_at
Template: DateTime.
- description
A composite field.
- data_shape
Template: LongText. A composite field.
- created_at
Template: DateTime.
- attribution
Template: LongText. A composite field.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/signals.Documentation: https://developers.salesloft.com/docs/api/signals-create.
- urgency
Template: ShortText.
- type
Template: ShortText.
- occurred_at
Template: ShortText.
- indicators
A composite field.
- idempotency_key
Template: ShortText.
- data
Template: LongText. A composite field.
- broadcast_notification
Data type: DT_BOOL
- attribution
A composite field.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/steps.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- type: Filter by step type.
- ids: IDs of steps to fetch..
- cadence_id: Filter by cadence ID.
- has_due_actions: Filter by whether a step has due actions.
Documentation: https://developers.salesloft.com/docs/api/notes-index.
- id
A key field. Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- disabled
Data type: DT_BOOL
- type
Template: ShortText.
- name
Template: ShortText.
- display_name
Template: ShortText.
- day
Data type: DT_I4
- step_number
Data type: DT_I4
- multitouch_enabled
Data type: DT_BOOL
- details
Template: RefT. A read-only field.
- cadence
Template: RefT. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/successes.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- person_id: Filters successes by person_id.
- ids: IDs of successes to fetch. If a record can't be found, that record won't be returned and your request will be successful.
Documentation: https://developers.salesloft.com/docs/api/successes-index.
- id
Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- succeeded_at
Template: DateTime.
- success_window_started_at
Template: DateTime.
- user
Template: RefT. A read-only field.
- person
Template: RefT. A read-only field.
- latest_email
Template: RefT. A read-only field.
- latest_call
Template: RefT. A read-only field.
- latest_action
Field components:
- Contains the following components: id.
- latest_cadence
Template: RefT. A read-only field.
- latest_step
Template: RefT. A read-only field.
- counts
Field components:
- Contains the following components: total_emails, total_calls, total_other_touches.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/tasks.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- user_id: Filters tasks by the user to which they are assigned.
- person_id: Filters tasks by the person to which they are associated.
- account_id: Filters tasks by the account to which they are associated.
- current_state: Filters tasks by their current state.
- task_type: Filters tasks by their task type.
- locale: Filters tasks by locale of the person to which they are associated.
- ids: IDs of tasks to fetch.
Documentation: https://developers.salesloft.com/docs/api/tasks-index.
- [Create] action
-
Endpoint URL address:
/tasks.Documentation: https://developers.salesloft.com/docs/api/tasks-create.
- [Update] action
-
Endpoint URL address:
/tasks/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/tasks-update.
- id
A key field. Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- idempotency_key
Template: ShortText.
- person_id
Template: ShortText.
- user_id
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
- description
Template: ShortText.
- due_date
Data type: DT_DATE
- due_at
Template: DateTime. A read-only field.
- subject
Template: ShortText.
- current_state
Template: ShortText. A read-only field.
- person
Template: RefT. A read-only field.
- user
Template: RefT. A read-only field.
- created_by_user
Template: RefT. A read-only field.
- task_type
Template: ShortText.
- remind_at
Template: DateTime.
- expires_after
Template: DateTime. A read-only field.
- completed_at
Template: DateTime. A read-only field.
- completed_by
Template: RefT. A read-only field.
- call
Data type: DT_I4 A read-only field.
Data type: DT_I4 A read-only field.
- general
Data type: DT_I4 A read-only field.
- integration
Data type: DT_I4 A read-only field.
- total
Data type: DT_I4 A read-only field.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/team_templates.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of team templates to fetch.
- tag_ids: Filters email templates by tags applied to the template by tag ID.
- search: Filters email templates by title or subject.
- tag: Filters team templates by tags applied to the template, not to exceed 100 tags.
Documentation: https://developers.salesloft.com/docs/api/team-templates-index.
- id
A key field. Template: ShortText.
- title
Template: ShortText.
- subject
Template: ShortText.
- body
Template: ShortText.
- body_preview
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- last_used_at
Template: DateTime.
- archived_at
Template: DateTime.
- last_modified_at
Template: DateTime.
- open_tracking_enabled
Data type: DT_BOOL
- click_tracking_enabled
Data type: DT_BOOL
- counts
Field components:
- Contains the following components: sent_emails, views, clicks, replies, bounces.
- last_modified_user
Template: RefT.
- _links
Field components:
-
Uses template:
ShortText. - Contains the following components: attachments.
-
Uses template:
- tags
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/team_template_attachments.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- ids: IDs of team template attachments to fetch.
- team_template_id: Filters template attachments by team template IDs.
Documentation: https://developers.salesloft.com/docs/api/team-template-attachments-index.
- id
A key field. Data type: DT_I4
- attachment_id
Data type: DT_I4
- team_template
Template: RefT. A read-only field.
- name
Template: ShortText.
- download_url
Template: ShortText.
- attachment_file_size
Data type: DT_I4
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/users.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- sort_direction: Available values: asc/desc
- sort_by: Key to sort on.
- ids: IDs of users to fetch.
- guid: Filters list to only include guids
- group_id: Filters users by group_id.
- role_id: Filters users by role_id.
- search: Space-separated list of keywords used to find case-insensitive substring matches against First Name, Last Name, or Email.
- active: Filters users based on active attribute.
Documentation: https://developers.salesloft.com/docs/api/users-index.
- [Update] action
-
Endpoint URL address:
/users/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/users-update.
- id
Data type: DT_I4 A read-only field.
- guid
Template: ShortText. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- name
Template: ShortText. A read-only field.
- first_name
Template: ShortText. A read-only field.
- last_name
Template: ShortText. A read-only field.
- job_role
Template: ShortText. A read-only field.
- active
Data type: DT_BOOL
- time_zone
Template: ShortText. A read-only field.
- locale_utc_offset
Data type: DT_I4 A read-only field.
- slack_username
Template: ShortText. A read-only field.
- twitter_handle
Template: ShortText. A read-only field.
Template: ShortText. A read-only field.
- email_client_email_address
Template: ShortText. A read-only field.
- sending_email_address
Template: ShortText. A read-only field.
- from_address
Template: ShortText. A read-only field.
- full_email_address
Template: ShortText. A read-only field.
- bcc_email_address
Template: ShortText. A read-only field.
- work_country
Template: ShortText.
- group_id
Template: ShortText.
- role_id
Template: ShortText.
- seat_package
Template: ShortText.
- email_signature
Template: ShortText. A read-only field.
- email_signature_type
Template: ShortText. A read-only field.
- email_signature_click_tracking_disabled
Data type: DT_BOOL A read-only field.
- team_admin
Data type: DT_BOOL A read-only field.
- local_dial_enabled
Data type: DT_BOOL A read-only field.
- click_to_call_enabled
Data type: DT_BOOL A read-only field.
- email_client_configured
Data type: DT_BOOL A read-only field.
- crm_connected
Data type: DT_BOOL A read-only field.
- external_feature_flags
Template: LongText. A read-only field. A composite field.
- phone_client
A read-only field. Field components:
- Contains the following components: id.
- phone_number_assignment
Template: RefT. A read-only field.
- group
Template: RefT. A read-only field.
- team
Template: RefT. A read-only field.
- role
Template: RefT. A read-only field.
Based on resource template WithSingle.
- [Read] action
-
Endpoint URL address:
/webhook_subscriptions.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- enabled: Filters webhook subscriptions by whether is enabled or not.
Documentation: https://developers.salesloft.com/docs/api/webhook-subscriptions-index.
- [Create] action
-
Endpoint URL address:
/webhook_subscriptions.Documentation: https://developers.salesloft.com/docs/api/webhook-subscriptions-create.
- [Update] action
-
Endpoint URL address:
/webhook_subscriptions/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/webhook-subscriptions-update.
- [Delete] action
-
Endpoint URL address:
/webhook_subscriptions/{{=item.id}}.Documentation: https://developers.salesloft.com/docs/api/webhook-subscriptions-destroy.
- id
A key field. Data type: DT_I4
- user_guid
Template: ShortText. A read-only field.
- tenant_id
Data type: DT_I4 A read-only field.
- event_type
Template: ShortText.
- enabled
Data type: DT_BOOL
- callback_url
Template: ShortText.
- callback_token
Template: ShortText.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}} -
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}} -
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
Based on resource template Base.
- [Read single] action
-
Endpoint URL address:
{{=resource.configuration.Read.toArray()[0].Url + '/' + parameters.id}}.
The result is extracted from:{{=[response.data]}}.The action has the following user-defined parameters:
- id: Required. Specify identifier.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- RefT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, _href.
-
Uses template:
- BulkJobDataT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, status, resource, record, error.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.