staqlydocs
REST APIAPI referenceAccounts

Change the signed-in person's notification choices

Change the signed-in person's notification choices

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

PUT
/v1/account/notifications

Events not listed keep their choice; scope is optional.

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Header Parameters

Idempotency-Key?string

Replays the stored response when the same key is repeated with the same method, path, query string and body within 24 hours (422 idempotency_mismatch with a different request, 409 idempotency_in_progress while the first one runs). Not applied to multipart uploads or to responses that carry a secret.

Lengthlength <= 200

Request Body

application/json
  1. body
scope?string
Value in"mine""all"
events?array<>

Response Body

OK

application/json
  1. response
scope*string
Value in"mine""all"
events*array<>
email*string

Where the emails go (the address the person signs in with)

mail_ready*boolean

The server can send email

curl -X PUT 'https://staqly.example.com/v1/account/notifications' \  -H 'Content-Type: application/json' \  -d '{}'
{  "scope": "mine",  "events": [    {      "event": "post.published",      "email": true,      "in_app": true    }  ],  "email": "string",  "mail_ready": true}