Skip to main content

Preview sequence audience

Preview enrollment eligibility for explicit lead IDs without enrolling them. Returns the audience evaluation, metadata, and sequence context.

POST/api/sequences/{sequence_id}/audience/preview
HTTP referenceScope sequences:readUpdated September 27, 2026

This page documents the canonical HTTP contract for this endpoint.

This endpoint only previews. Use Enroll sequence leads or Enroll a selected audience for an explicit mutation. Selection syntax and workspace fields are described in the workspace selection catalog.

Path parameters

  • sequence_idrequired

    string

    Sequence identifier.

Query parameters

  • limit · optional

    integer

    Maximum audience rows to return.

  • offset · optional

    integer

    Number of audience rows to skip.

Body parameters

  • leadIdsrequired

    array<string>

    Lead IDs to evaluate.

  • researchContext · optional

    object

    Optional source-table context used to resolve sequence variables.

  • variableMap · optional

    object<string,string>

    Optional variable-to-column mapping.

Errors

StatusMeaning
401Authentication is missing or invalid.
403Missing sequences:read.
404Sequence not found.

Docs