Sequences

The Sequences API provides a simple interface to read Lead Sequences. This automation is available only if you have bought our Reach product. Administrator can manage (add, update and delete) sequences directly in web settings under Lead sequences section.

Sequence is a set of steps and timeliness of their execution. Each Step can be either an automated_email or a task and can be defined to be executed after previous step in X weekdays or hours. Think of it as a template that is later used to start the Sequence for particular lead (see: Sequence Enrollments section for more details).

SequenceStep properties

Attribute Description
id
number
readonly
Unique identifier of step
position
number
readonly
Zero-based step’s position in sequence
delay_from_previous_step
number
Time that should pass in between execution of this and previous step
delay_from_previous_step_unit
string
Unit of the time that should pass in between execution of this and previous step

Possible values
  • hours
  • weekdays - days between Monday and Friday
action_properties
object
Object containing attributes from sequence that configure this step

Properites for automated email:
  • email_template_id - id of a email template that will be send in this step
  • is_reply - boolean (true, false) - whether email should be sent as a reply or as a new thread

Properties for task:
  • task_content - content of task that will be created for this step

Properties

Attribute Description
id number readonly

Unique identifier of the enrollment.

name string

Name of the sequence.

steps_total number readonly

Total number of steps in the sequence .

creator_id number readonly

Unique identifier of user that created this sequence.

created_at string readonly

Date and time that the enrollment was created in UTC (ISO8601 format).

updated_at string readonly

Date and time of the last update on the enrollment in UTC (ISO8601 format).

steps array

Array of steps that this sequence consists of. Attributes of steps are explained in the table above.


Endpoints


Retrieve all sequences

Returns all sequences available to the user according to the parameters provided.

Parameters

Attribute Description
page number optional

Page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page.

e.g. ?page=2
per_page number optional

Number of records to return per page. Default limit is 25 and the maximum number that can be returned is 100.

e.g. ?per_page=20
ids string optional

Comma-separated list of sequence identifiers to be returned in a request.

e.g. ?ids=1,2,3
name number optional

Sequence’s name substring. All matching sequence will be returned.

e.g. ?name=1