Explain whether a Contact matches a Segment, using the given externalId

Shows which of the segment's groups and conditions the contact matches, and describes each condition in plain language. A match is evaluated as the requesting user, so a contact that user cannot see is reported as not found. A field whose value could not be determined is left out: translation when the segment could not be translated, contact_matches_group when a condition whose result is unknown would decide the group.

Path Params
string
required

The segment to explain, by UUID or legacy numeric id

string
required

The contact to evaluate

string
required

The external id that the segment's conditions are evaluated against. required when a condition refers to "this" such as: "this deal" or "this custom object" (in which case the external id would be a Deal's ID or a Custom Object's ID). This type of condition is generally only utilized in Automation blocks.

Responses

401

Unauthorized

403

Forbidden

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json