Reply (API V3)

Reply is a sales engagement platform that helps you automate and scale multichannel outreach to generate more leads, acquire new customers and grow revenue faster.

Data integration: Skyvia supports importing data to and from Reply, exporting Reply data to CSV files, replicating Reply data to relational databases, and synchronizing Reply data with other cloud apps and relational databases.

Backup: Skyvia Backup does not support Reply.

Query: Skyvia Query supports Reply.

Establishing Connection

To create a connection to Reply, you need to enter your API Key.

Getting Credentials

To get your Reply API Key, perform the following steps:

Sign in to Reply.
Click Settings in the toolbar.
Click API Key in the left menu.
Copy the API Key.

Creating Connection

Select the API version.
Enter the API Key in the Connection Editor.

Connector Specifics

Object Peculiarities

Sequences

The fields Steps, ScheduleId, EmailAccounts, LinkedInAccounts, Settings*_ are used for INSERT/UPDATE operations and return the empty result when used in SELECT-statements.

The Steps field is an array with a complex structure. When you import data to this field, the set of available nested fields depends on the value of the Type array item.

SequenceSteps

When you import data to this object, the set of the fields required for mapping depends on the value of the Type field.

Nested Objects (or separate object name)

The fields below store complex structured data in JSON format.

Object	Field
Sequences	Steps
Schedules	MainTimings, FollowUpTimings, Ranges
Holidays	HolidayCalendars

You can use our Nested Objects mapping feature in the Import integrations to insert or update the nested values in such fields. Select the Separate Tables for the Unwind Nested Objects option when using the new replication runtime to replicate the nested data into separate tables.

DML Operations Support

Operation	Object
INSERT, UPDATE, DELETE	Accounts, ContactLists, Contacts, CustomFields, DomainBlacklistRules, EmailAccounts, EmailBlacklistRules, EmailExceptionBlacklistRules, EmailTemplateFolders, EmailTemplates, HolidayCalendars, Schedules, SequenceFolders, Sequences, SequenceSteps, SequenceStepVariants, Tasks, Webhooks
INSERT, DELETE	SequenceEmailAccounts, SequenceLinkedInAccounts

Incremental Replication and Synchronization

Skyvia supports Replication with Incremental Updates for the following objects: Accounts, Contacts, SequenceContacts, Sequences, SequencesInFolder, Webhooks.

Skyvia supports Synchronization for the following Reply objects: Accounts, Contacts, Sequences, Webhooks.

Stored Procedures

Skyvia represents part of the supported Reply features as stored procedures. You can call a stored procedure, for example, as a text of the command in the ExecuteCommand action in a Target component of a Data Flow or in Query.

StartSequence

The command below starts an existing sequence.

call StartSequence(:SequenceId)

PauseSequence

To pause a running sequence use the following command.

call PauseSequence(:SequenceId)

ArchiveSequence

To archive an existing sequence use the following command.

call ArchiveSequence(:SequenceId)

SetContactStatus

To set the status of one or more contacts use the following command.

call SetContactStatus(:ContactIds, :Status, :SequenceId)

Parameter	Description
ContactIds	Required. An array of integers representing the contact IDs. For example: `[1, 2, 3]`
Status	Required. The status to set. Can be one of the following values: `Active`, `Paused`, `OutOfOffice`, `Finished`, `OptedOut`, `Replied`, `Bounced`, `Called`, `ToCall`, `MeetingBooked`
SequenceId	Optional. The ID of the sequence to associate with the contacts

ClearContactStatus

To clear one or more statuses from contacts use the following command.

call ClearContactStatus(:ContactIds, :Statuses, :SequenceId)

Parameter	Description
ContactIds	Required. An array of integers representing the contact IDs. Example: `[1, 2, 3]`
Statuses	Optional. An array of statuses to clear. If no statuses are specified, the procedure clears all clearable statuses: `OptedOut`, `Called`, `ToCall`, `MeetingBooked`. For example: `["OptedOut"]`
SequenceId	Optional. The ID of the sequence to clear statuses for

AddNoteToContact

To add a note to an existing contact use the following command.

call AddNoteToContact(:ContactId, :Notes)

Parameter	Description
ContactId	Required. The ID of the contact to add a note to
Notes	Required. The text of the note to add to the contact

MoveContactToSequence

The command below moves a contact to a different sequence, optionally removing from existing sequences.

call MoveContactToSequence(:ContactId, :SequenceId, :RemoveFromExisting, :StartStepId, :IgnoreStepDelay, :StartFrom)

Parameter	Description
ContactId	Required. The ID of the contact to move
SequenceId	Required. The ID of the sequence to move the contact to
RemoveFromExisting	Optional. Defines whether to remove the contact from all existing sequences. Set to `true` to remove the contact from all other sequences, `false` to keep them in all sequences
StartStepId	Optional. The ID of the step in the target sequence to start from
IgnoreStepDelay	Optional. Define if the delay between steps should be ignored. Set to `true` to start immediately, `false` to respect the delay settings of the target sequence
StartFrom	Optional. The date and time to start from. The format is ISO 8601, e.g., `"2023-10-27T10:00:00"`

SetSequenceEmailAccounts

The command below replaces all email account links for the sequence with the provided list.

call SetSequenceEmailAccounts(:SequenceId, :EmailAccountIds)

Parameter	Description
SequenceId	Required. The ID of the sequence to set the email account links for
EmailAccountIds	Required. An array of integers representing the email account IDs. Example: `[ 12345, 67890 ]`

BulkAssignSequencesToFolder

The command below assigns multiple sequences to a folder.

call BulkAssignSequencesToFolder(:FolderId, :SequenceIds)

Parameter	Description
FolderId	Required. The ID of the folder to assign the sequences to
SequenceIds	Required. An array of integers representing the sequence IDs. Example: `[ 123, 456 ]`

BulkUnassignSequencesToFolder

To remove multiple sequences from a folder use the following command.

call BulkUnassignSequencesToFolder(:FolderId, :SequenceIds)

Parameter	Description
FolderId	Required. The ID of the folder to remove the sequences from
SequenceIds	Required. An array of integers representing the sequence IDs. Example: `[ 123, 456 ]`

DeleteSequenceTemplate

To delete an existing sequence template use the following command.

call DeleteSequenceTemplate(:TemplateId)

MoveContactsToContactList

To move contacts to the specified contact list use the following command.

call MoveContactsToContactList(:ListId, :ContactIds)

Parameter	Description
ListId	Required. The ID of the contact list to move the contacts to
ContactIds	Required. An array of integers representing the contact IDs. Example: `[ 123, 456 ]`

AddContactsToContactList

To add contacts to the specified contact list use the following command.

call AddContactsToContactList(:ListId, :ContactIds)

Parameter	Description
ListId	Required. The ID of the contact list to add the contacts to
ContactIds	Required. An array of integers representing the contact IDs. Example: `[ 123, 456 ]`

ReassignTask

Changes the assigned user for a single task. The target user must be a member of the caller’s team.

call ReassignTask(:TaskId, :UserId)

Parameter	Description
TaskId	Required. The ID of the task to reassign
UserId	Required. The ID of the user to reassign the task to

CompleteTask

Completes a task, optionally finishing the prospect's sequence.

call CompleteTask(:TaskId, :CallResolution, :FinishProspectInSequence)

Parameter	Description
TaskId	Required. The ID of the task to complete
CallResolution	Optional. The resolution of the call task
FinishProspectInSequence	Optional. Whether to finish the prospect's sequence

ExecuteAndCompleteTask

Executes the task action (sends email or SMS) and completes it. Only ManualEmail and Sms task types support execution.

call ExecuteAndCompleteTask(:TaskId, :ContentBody, :ContentSubject, :EmailAccountId)

Parameter	Description
TaskId	Required. The ID of the task to execute and complete
ContentBody	Optional. The body of the email or SMS
ContentSubject	Optional. The subject of the email
EmailAccountId	Optional. The ID of the email account to use