Check whether a contact is in a List
Returns the membership boolean for a contact in a List. A missing List
is 404 not_found, but a non-member contact returns 200 with
is_member: false (membership is a property of the List, not a
sub-resource that can 404).
Path parameters
id string required The List's UUID or, when the value does not parse as a UUID, its org-unique key. Unknown handles read as 404 not_found. Accepted on every List route, read and write alike.
contactId string required The contact's UUID, its external_id, or its email address (percent-encoded). Addressing the contact by external_id or email additionally requires the api.contacts.view scope — turning an address into a contact is a contacts read — and returns 403 invalid_scope without it; the UUID form needs only this route's own scope. A handle that names no contact in the org is 422 validation_failed, which is distinct from a known contact who is simply not a member (200 with is_member: false).
Responses
Errors follow the RFC 7807 problem format — see the error reference.
list_id string<uuid> required contact_id string<uuid> required is_member boolean required validation_failed Problem. When the refusal is about a
reference — a segment key, template slug, topic or attribute name the
organization does not have — it additionally carries validation_code,
field, line/column, missing, candidates and next_step, so a
client can correct the call without a second round of guessing. See
ValidationProblem.
application/problem+json code is internal_error. The
request_id field can be quoted to SendOps support to investigate.
application/problem+json