/v1/definitions/{key}/audience/{mode}Set who a page is shown to
Works out who on a page a blast would reach. :mode is preview — the counts plus a small sample, 10 rows by default and at most 25 — or resolve, the full list the send will use, 500 by default and at most 2500 with a truncated flag; any other word is a 404. The body narrows by row_ids, statuses, tags, search, state, send_type, has_email, has_phone, require_any_contact and exclude_do_not_contact, and the summary counts how many are reachable by email, by SMS and by both. A body that selects nothing answers no_selection rather than the whole page, and archived records are never included.
Access class: def:read.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredResponses
the action's answer
{
"data": {
"limit": 1,
"no_selection": true,
"rows": [
{
"archived_at": "string",
"assignees": "string",
"cells": "string",
"createdBy": "string",
"display": "string",
"externalId": "",
"groupId": "",
"id": "",
"position": "string",
"source": "string"
}
],
"summary": {
"email_and_sms_eligible": 1,
"email_eligible": 1,
"sms_eligible": 1,
"total": 1
},
"truncated": true
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}