POST notifications/send/{id}

POST /api/v2/notifications/send/{id}

Sends push notifications to participant account IDs within a given event. Supports optional category filtering. Notifications are dispatched asynchronously in batches of 100.


Authentication

Authorization: Bearer <your_api_key>

Endpoint

POST /api/v2/notifications/send/{id}

Content-Type: application/json


Path Parameters

Parameter

Type

Required

Description

id

integer

Yes

The event ID (in the URL path)


Body Parameters

Parameter

Type

Required

Description

content

object

Yes

Language-keyed message object (e.g. {"en": "Hello world"}). Max 235 chars per value

user_ids

integer[]

Yes

Account IDs to notify. 1–2000 entries

subject

string

No

Category filter. ||-delimited category names (e.g. "Visitors||Buyers")

link

any

No

Deep-link target

linkType

string

No

Deep link type (e.g. "exhibitor", "session")


Example Request

Bash
curl -X POST "https://your-event-domain.com/api/v2/notifications/send/7" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": { "en": "The keynote starts in 15 minutes. Head to Hall A." },
    "user_ids": [18629, 18630, 18631]
  }'

Error Responses

HTTP Code

Condition

Error Message

400

Required field missing

Missing required parameter: {field}

400

user_ids exceeds 2000

Limit reached for param user_ids (2000 max)

400

Content exceeds 235 chars

Max content length is 235

403

Missing or invalid API key

Forbidden