Skip to main content
POST
/
enrollments
cURL
curl --request POST \
  --url https://api.unifygtm.com/sequences/v1/enrollments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mailbox_emails": [
    "jsmith@example.com"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "sequence": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "is_paused": true
  },
  "person": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "jsmith@example.com",
    "first_name": "<string>",
    "last_name": "<string>",
    "linkedin_url": "<string>"
  },
  "mailbox": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "jsmith@example.com",
    "display_name": "<string>",
    "is_paused": true,
    "is_unauthorized": true
  },
  "reply_email_message": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subject": "<string>",
    "classifications": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "received_at": "2023-11-07T05:31:56Z"
  },
  "is_blocked": true,
  "is_bounced": true,
  "is_canceled": true,
  "is_excluded": true,
  "is_opted_out": true,
  "is_paused": true,
  "is_replied": true,
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z"
}

​
Overview

Create an enrollment to add a person to a sequence. The request body specifies:
PropertyBehavior
sequence_idThe sequence to enroll the person in.
person_idThe person to enroll.
mailbox_emailsCandidate mailbox addresses to send from. One is selected at enrollment time. At least one and at most ten addresses are accepted.
If the person is already actively enrolled in the sequence, the request returns 409 Conflict.

Authorizations

​
x-api-key
string
header
required

Body

application/json

Request body for enrolling a person in a sequence.

​
sequence_id
string<uuid>
required

String UUID value.

​
person_id
string<uuid>
required

String UUID value.

​
mailbox_emails
string<email>[]
required

Candidate mailbox addresses to send from. One is selected at enrollment time. At most 10 addresses are accepted.

Required array length: 1 - 10 elements

String value representing an email address.

Response

Response returned when an enrollment is created.

Response returned when an enrollment is created.

​
id
string<uuid>
required

String UUID value.

​
created_at
string<date-time>
required

String value representing an RFC 3339 datetime.

​
updated_at
string<date-time>
required

String value representing an RFC 3339 datetime.

​
sequence
object
required

Sequence details embedded in enrollment responses.

​
person
object
required

Person details embedded in enrollment responses.

​
mailbox
object
required

Mailbox details embedded in enrollment responses.

​
reply_email_message
object
required

Reply email message details embedded in enrollment responses.

​
status
enum<string>
required

Status of a sequence enrollment.

Available options:
DRAFT,
IN_PROGRESS,
FINISHED
​
is_blocked
boolean
required
​
is_bounced
boolean
required
​
is_canceled
boolean
required
​
is_excluded
boolean
required
​
is_opted_out
boolean
required
​
is_paused
boolean
required
​
is_replied
boolean
required
​
started_at
string<date-time>
required

String value representing an RFC 3339 datetime.

​
ended_at
string<date-time>
required

String value representing an RFC 3339 datetime.