Sign in
Basic

Enroll a contact in a sequence

Enroll a contact into a sequence using the specified user ID and sequence details.

post/automation/v4/sequences/enrollments

Query parameters

userIdstring required

Request body

contactIdstring required

The unique identifier of the contact to be enrolled in the sequence.

senderAliasAddressstring

The alias email address used by the sender when enrolling the contact.

senderEmailstring required

The email address of the sender enrolling the contact in the sequence.

sequenceIdstring required

The unique identifier of the sequence in which the contact will be enrolled.

Response

successful operation

enrolledAtstring date-time required

The date and time when the contact was enrolled in the sequence.

idstring required

The unique identifier for the sequence enrollment.

toEmailstring required

The email address of the contact enrolled in the sequence.

updatedAtstring date-time required

The date and time when the sequence enrollment was last updated.

Changes

Changed in 5 of the 57 revisions of this API.18

  • v41eeb2fde68831See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v49806ae62d2f11See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v44437b130c7912See the full diff
    • ○

      the security scope automation.sequences.enrollments.write was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope sequences-enrollments-public-write-access was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v4f02323380ddf4See the full diff
    • ○

      the endpoint scheme security app_cookie was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security hapikey was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security internal_cookie was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security shhkey was removed from the API

      api-security-removed

  • v44d21ec7889671See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog