Skip to content
Notavia Notavia Docs

Set a single preference cell for a user

PATCH
/v1/preferences/users/{externalUserId}/{categoryKey}/{channel}
 
curl --request PATCH \
  --url https://your-notavia-host/v1/preferences/users/example/example/email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "opted_in": true }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
externalUserId
required
string
categoryKey
required
string
channel
required

Kebab-case channel identifier used in URL path segments and template body keys.

string
Allowed values: email in_app sms slack teams discord

Request Body required

Section titled “Request Body required ”
Media type application/json
object
opted_in
required
boolean
Example generated
{
  "opted_in": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated preference cell.

401

Section titled “401 ”

Missing or invalid credentials.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

403

Section titled “403 ”

Credentials do not have the required scope.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

404

Section titled “404 ”

Resource not found.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

409

Section titled “409 ”

Conflict (e.g. duplicate key, idempotency collision).

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}