Skip to content
Notavia Notavia Docs

Update a notification category

PUT
/v1/preferences/categories/{key}
 
curl --request PUT \
  --url https://your-notavia-host/v1/preferences/categories/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "default_channels": [ "email" ], "default_opt_in": true }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
key
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required
string
description
string
nullable
default_channels
required
Array<string>
Allowed values: email in_app webhook sms slack teams discord
default_opt_in
required
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated category.

Media type application/json
object
id
string format: uuid
key
string
name
string
description
string
nullable
is_critical
boolean
default_channels
Array<string>
Allowed values: email in_app webhook sms slack teams discord
default_opt_in
boolean
is_archived
boolean
Example 
{
  "default_channels": [
    "email"
  ]
}

400

Section titled “400 ”

Validation or request error.

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"
  }
}

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"
  }
}