Skip to content
Notavia Notavia Docs

Create a notification category

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

Authorizations

Section titled “Authorizations ”

Request Body required

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

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Category created.

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

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