Update notification preferences

Turns a category's email or dashboard notifications on or off; the rest keep theirs. Free.

Auth: an API key with the admin scope, or the dashboard session.

Test mode: A test key's change is validated and answered but not stored: test mode never changes the live account.

Example

cURL

curl -X PATCH 'https://staging.socialtap.dev/v1/notification_preferences' \
  -H "x-api-key: $SOCIALTAP_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "categories": [
    {
      "category": "credits"
    }
  ]
}'

Authorizations

x-api-keystringheaderrequired

Your API key, with the admin scope. Authentication

Body

application/json

JSON. Fields marked nullable may be null; optional ones may be left out.

Field	Type	Description
`categories`	`object[]`	The categories to change, each at most once.
`categories[].category`	`string`	The notification category. One of `credits`, `spend_limits`, `jobs`, `api_keys`, `webhooks`
`categories[].email?`	`boolean` or `null`	Email on or off; only for a category that sends email (its email is not null).
`categories[].in_app?`	`boolean` or `null`	Shown in the dashboard's notifications, or not.

categoriesobject[]

The categories to change, each at most once.

Show 3 child fields

categorystring

The notification category.

One ofcreditsspend_limitsjobsapi_keyswebhooks

email?booleannullable

Email on or off; only for a category that sends email (its email is not null).

in_app?booleannullable

Shown in the dashboard's notifications, or not.

Field	Type	Description
`data`	`object`
`data.categories`	`object[]`	Every notification category, in display order. Security email is in none: it is always sent.
`data.categories[].category`	`string`	The notification category. One of `credits`, `spend_limits`, `jobs`, `api_keys`, `webhooks`
`data.categories[].email`	`boolean` or `null`	Whether the owner is emailed (default on); null when the category sends no email.
`data.categories[].in_app`	`boolean`	Whether the dashboard shows it (default on). Webhooks always get every event.
`data.object`	`string`	Always notification_preferences. One of `notification_preferences`
`meta`	`object`	The shared route meta (see the API reference introduction).

Code	HTTP	Retry	Meaning	What to do
`invalid_input`	400	No	The request parameters are missing or malformed, or the URL is not a supported link for this endpoint.	Fix the parameter named in param (the message says how); for a link of the wrong kind, call the endpoint the message names.

Code	HTTP	Retry	Meaning	What to do
`unauthorized`	401	No	The x-api-key header is missing, unknown or revoked (or, on the dashboard's routes, the session cookie is missing or expired).	Send a valid API key in the x-api-key header; without one, get a key at details.signup_url (AI agents: POST details.agent_signup_url).

Code	HTTP	Retry	Meaning	What to do
`forbidden`	403	No	The API key is valid but may not make this request: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include; or the request used a rotated key's previous secret (or one no longer current) for something that needs the admin scope. A running job stops the same way when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item (a private item is private_or_unavailable, also 403): branch on the code.	Do what details.reason says: if suspended, contact support; otherwise use a key whose scopes cover the route (details.required_scope) or the key's new secret after a rotation, have the owner confirm the emailed link, create a new key, or call from an allowed IP.

The API key is valid but may not make this request: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include; or the request used a rotated key's previous secret (or one no longer current) for something that needs the admin scope. A running job stops the same way when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item (a private item is private_or_unavailable, also 403): branch on the code.

Do what details.reason says: if suspended, contact support; otherwise use a key whose scopes cover the route (details.required_scope) or the key's new secret after a rotation, have the owner confirm the emailed link, create a new key, or call from an allowed IP.

429

429 Too Many Requests.

Code	HTTP	Retry	Meaning	What to do
`rate_limited`	429	Yes, later	The account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead.	Wait for the number of seconds in the retry-after header, then retry; ask support to raise the ceiling if your sustained traffic needs more (calls without an API key: use one).

rate_limitedYes, later

The account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead.

Wait for the number of seconds in the retry-after header, then retry; ask support to raise the ceiling if your sustained traffic needs more (calls without an API key: use one).

Test mode

A test key's change is validated and answered but not stored: test mode never changes the live account.

operationId notification_preferences.update

Example

Authorizations

Body

Response

200

400

401

403

429

Test mode