Skip to main content

Create sequence

POST 
/sequences

Note this uses an undocumented private api endpoint for Apollo and should be considered to be in alpha state

Request​

Header Parameters

    x-customer-id stringrequired

    The customer ID that uniquely identifies the customer in your application

    Example: my-customer-1
    x-provider-name stringrequired

    The provider name

    Example: salesforce

Body

required
    record objectrequired
    name stringrequired
    tags string[]

    Raw values in Outreach, ids in Apollo, and not supported in Salesloft

    type stringrequired

    Possible values: [team, private]

    The share type of the sequence. Setting to team will share with the whole team. private will only share with the owner.

    owner_id string
    steps object[]
  • Array [
    • name string

    The name given by the user for the step. Used by Salesloft only.

    interval_seconds number

    The interval (in seconds) until this step will activate after the previous step (in case of first step, relative to when prospect first enters a sequence); only applicable to interval-based sequences. This is 0 by default

    date string

    The date this step will activate; only applicable to date-based sequences.

    template object

    The email/message template to be used for this step. Only applicable for email or message steps.

    oneOf
    id stringrequired

    The ID of the template to use for this step.

    is_reply boolean

    If true, this step will be sent as a reply to the previous step.

    order number

    The step's display order within its sequence. Only applicable for Outreach when adding steps one at a time after the initial sequence creation, otherwise when creating steps together with sequence order is implicit based on the order of step within the step array. Salesloft does not use the order param, and order is instead determined by interval_seconds which translates into the day parameter

    type stringrequired

    Possible values: [auto_email, manual_email, call, task, linkedin_send_message]

    The type of the sequence state. Note: linkedin_send_message is undocumented in Outreach and subject to change.

    See below for how these types are mapped:

    Providerauto_emailmanual_emailcalltasklinkedin_send_message
    Apolloauto_emailmanual_emailcallaction_itemlinkedin_send_message
    Outreachauto_emailmanual_emailcalltasklinkedin_send_message
    SalesloftEmailEmailPhoneOther(Not supported)
    task_note string

    An optional note to be attached to this step.

    custom_fields object

    Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.

    property name* any

    Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.

  • ]
    • custom_fields object

    Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.

    property name* any

    Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.

Responses​

Sequence created

Schema
    record object
    id stringrequired
    warnings object[]
  • Array [
    • detail string
    problem_type string
    title string
  • ]
Loading...