POST
/
v1
/
notifications
/
preferences
/
profiles
curl --request POST \
  --url https://platform.thena.ai/v1/notifications/preferences/profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-org-id: <api-key>' \
  --data '{
  "description": "Out of office profile",
  "isCurrent": false,
  "isDefault": true,
  "groupingType": "no_grouping",
  "batchingType": "no_batching",
  "batchCount": 123,
  "batchDuration": 123,
  "title": "Out of office",
  "configuration": [
    {
      "eventType": "ticket_created",
      "channelType": "push",
      "isEnabled": true
    }
  ]
}'
{
  "id": "<string>",
  "title": "<string>",
  "description": "<string>",
  "isCurrent": true,
  "isDefault": true,
  "configuration": [
    {
      "eventType": "ticket_created",
      "channelType": "push",
      "isEnabled": true
    }
  ],
  "groupingType": "no_grouping",
  "batchingType": "no_batching",
  "batchCount": 123,
  "batchDuration": 123,
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

Authorization
string
header
required

Enter JWT bearer token

x-org-id
string
header
required

Enter organization ID

Body

application/json
title
string
required

The title of the user notification preference profile

Example:

"Out of office"

configuration
object[]
required

The configuration of the user notification preference profile

description
string

The description of the user notification preference profile

Example:

"Out of office profile"

isCurrent
boolean
default:false

Whether the user notification preference profile is current

isDefault
boolean
default:true

Whether the user notification preference profile is default

groupingType
enum<string>

The grouping type of the user notification preference profile

Available options:
no_grouping,
group_by_event,
group_by_entity,
group_by_entity_and_event
batchingType
enum<string>

The batching type of the user notification preference profile

Available options:
no_batching,
batch_by_entity
batchCount
number

The maximum number of notifications to send in a batch

batchDuration
number

The maximum duration of a batch in minutes

Response

201
application/json
Operation successful
id
string
required

The id of the user notification preference profile

title
string
required

The title of the user notification preference profile

description
string
required

The description of the user notification preference profile

isCurrent
boolean
required

Whether the user notification preference profile is current

isDefault
boolean
required

Whether the user notification preference profile is default

configuration
object[]
required

The configuration of the user notification preference profile

groupingType
enum<string>
required

The grouping type of the user notification preference profile

Available options:
no_grouping,
group_by_event,
group_by_entity,
group_by_entity_and_event
batchingType
enum<string>
required

The batching type of the user notification preference profile

Available options:
no_batching,
batch_by_entity
batchCount
number
required

The maximum number of notifications to send in a batch

batchDuration
number
required

The maximum duration of a batch in minutes

createdAt
string
required

The created at date of the user notification preference profile

updatedAt
string
required

The updated at date of the user notification preference profile