Basic

Enroll a contact in a sequence

Changed on

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

post/automation/sequences/2026-03/enrollments

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/automation/sequences/2026-03/enrollments
  • Auth
    OAuth 2
    Authorization code: https://app.hubspot.com/oauth/authorize
    Token URL: https://api.hubapi.com/oauth/v1/token scopes: automation.sequences.enrollments.write

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

  • 2026-03f91a8d094ac3Revision changes
    • info

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

    • info

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

  • 2026-03e9de2247a2cfRevision changes
    • info

      the endpoint scheme security app_cookie was removed from the API

    • info

      the endpoint scheme security hapikey was removed from the API

    • info

      the endpoint scheme security internal_cookie was removed from the API

    • info

      the endpoint scheme security shhkey was removed from the API