SEsequenzy
Sequences

Estimate a sequence audience enrollment

Changed on

Counts the contacts matching an audience and how many of them would be enrolled. Contacts already in the sequence are skipped; one_time sequences also skip contacts who completed or were cancelled before. Nothing is changed.

post/sequences/{sequenceId}/enroll-audience/estimate

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enroll-audience/estimate
  • Auth
    HTTP bearer

Path parameters

sequenceIdstring required

Sequence ID.

Request body

Example request

{
  "audience": {
    "type": "lists",
    "listIds": [
      "list_abc123"
    ],
    "segmentId": "seg_abc123",
    "includedSubscriberIds": [
      "sub_abc123",
      "sub_def456"
    ]
  }
}

Response

Estimate

successboolean
matchingCountinteger

Active contacts with an email matching the audience.

alreadyEnrolledCountinteger

Matching contacts that would be skipped because they are already in the sequence.

enrollableCountinteger

Example response

{
  "success": true,
  "matchingCount": 12000,
  "alreadyEnrolledCount": 200,
  "enrollableCount": 11800
}

Changes