Skip to main content
POST
Contact status
Use this endpoint to check whether a contact is blocked or opted out before sending.

Authorizations

Authorization
string
header
required

Recommended authentication for new integrations. Generate a short-lived JWT from your API Secret ID and API Secret Key, then pass the signed JWT as a bearer token in the Authorization header.

API Secret credentials are available in the Heymarket app under Settings > Integrations > API. The Secret Key is shown only when it is generated, so copy and store it securely before closing the dialog.

Use the following JWT values:

Replace CURRENT_UNIX_TIMESTAMP with the current Unix timestamp in seconds when generating the token.

Sign the JWT with HMAC-SHA256 using this signing secret:

Send the signed JWT as a bearer token:

Tokens expire 5 minutes after the iat timestamp. Generate a new JWT per request, or cache it briefly for less than 5 minutes. Generate JWTs only from trusted server-side code; do not expose the API Secret Key in browser, mobile, or other client-side code.

Body

application/json

Heymarket ID of the contact

id
integer
Example:

10000

phone
string<phone>
Example:

"12345678900"

Response

Status of the contact

id
integer
Example:

10000

phone
string<phone>
Example:

"12345678900"

unsubscribed
boolean
Example:

false

unsubscribed_contact
boolean
Example:

false

unsubscribed_admin
boolean
Example:

false

blocked
boolean
Example:

false

inbox_opt_outs
object[]

Inboxes this contact is opted out of via inbox-scoped opt-outs. Only present when the number has inbox-scoped opt-out rows; omitted otherwise and for global (team-wide) opt-outs. The unsubscribed, unsubscribed_contact, and unsubscribed_admin booleans above keep their existing any-row semantics and are unaffected by this field.

global_opt_out
boolean

True when the number has a team-wide (non-inbox-scoped) opt-out row, independent of inbox_opt_outs. Always present, including when false. The two kinds coexist: with this true, the contact is blocked on every inbox, including inboxes absent from inbox_opt_outs — read both fields before treating an inbox as sendable.

Example:

false