POST
/
v5
/
app
/
notification_requests
curl --request POST \
  --url https://{defaultHost}/v5/app/notification_requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "body": {
    "title": "<string>",
    "subtitle": "<string>",
    "content": "<string>"
  },
  "topics": [
    {
      "topic_identifier": "<string>",
      "users": [
        "<string>"
      ]
    }
  ],
  "sender_user_id": "<string>",
  "external_id": "<string>",
  "link": "<string>",
  "rest_path": "<string>",
  "target": {
    "experience": "<string>"
  }
}'
{
  "status": "created",
  "message": "We will attempt to send out your notification. This is processed in a background job, so we cannot confirm how many notifications were sent in this request."
}

Authorizations

Authorization
string
header
required

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

Body

application/json
body
object
required
topics
object[]
required
target
object
required
sender_user_id
string
external_id
string
rest_path
string

Response

201
application/json
notification request created
status
string
Example:

"created"

message
string
Example:

"We will attempt to send out your notification. This is processed in a background job, so we cannot confirm how many notifications were sent in this request."