Skip to main content
PATCH
Update Notification Preferences

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace. Refused with 404 (Workspace not found.) when the id is unknown, is not one of your customers, or is not an org_… id; 410 when that customer was deleted (restore it with POST /customers/{id}/restore until it is erased); 403 when the key belongs to one customer workspace (it cannot act as another); 400 when your workspace is not a developer workspace. /customers/* and GET /customers/usage are your own workspace's and refuse the header with 400: call them without it.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Body

application/json

One key per category to change (at least one), each an object with muted and/or email. Any other key is refused.

meta
object

Send muted, email or both; the other keeps its value.

templates
object

Send muted, email or both; the other keeps its value.

campaigns
object

Send muted, email or both; the other keeps its value.

calls
object

Send muted, email or both; the other keeps its value.

inbox
object

Send muted, email or both; the other keeps its value.

knowledge
object

Send muted, email or both; the other keeps its value.

billing
object

Send muted, email or both; the other keeps its value.

system
object

Send muted, email or both; the other keeps its value.

members
object

Send muted, email or both; the other keeps its value.

{key}
object

Send muted, email or both; the other keeps its value.

Response

Every category, as they now are.

items
object[]
required
nextCursor
null
required

Always null: every category is in one answer.