Skip to main content
POST
/
v5
/
app
/
notification_topics
Create a Notification Topic
curl --request POST \
  --url https://{defaultHost}/v5/app/notification_topics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "topic_identifier": "<string>",
  "description": "<string>",
  "notification_channel_identifiers": [
    "email"
  ],
  "status": "active",
  "topic_type": "company"
}'
{
  "app_id": "<string>",
  "created_at": 123,
  "name": "<string>",
  "description": "<string>",
  "notification_channel_identifiers": [
    "email"
  ],
  "status": "active",
  "topic_identifier": "<string>",
  "topic_type": "company",
  "visibility": "visible"
}

Authorizations

​
Authorization
string
header
required

App API key for /v5/app and /v5/company endpoints

Body

application/json
​
name
string
required

The name of the notification topic

​
topic_identifier
string
required

The identifier of the notification topic

​
notification_channel_identifiers
enum<string>[]
required
​
topic_type
enum<string>
required
Available options:
company,
user
​
description
string

The description of the notification topic

​
status
enum<string>
Available options:
active,
inactive

Response

201 - application/json

notification topic created

​
app_id
string
required

The ID of the app, which will look like app_*************

​
created_at
number
required

The date the notification topic was created as a unix timestamp.

​
name
string
required

The name of the notification topic

​
notification_channel_identifiers
enum<string>[]
required
​
status
enum<string>
required

The status of the notification topic

Available options:
active,
inactive
​
topic_identifier
string
required

The identifier of the notification topic

​
topic_type
enum<string>
required

The type of the notification topic

Available options:
company,
user,
company_team
​
visibility
enum<string>
required

The visibility of the notification topic

Available options:
visible,
hidden
​
description
string | null

The description of the notification topic