API Reference
POST /api/admin/broadcasts/execute
API Reference
- POSTPOST /api/public/apps/identify
- POSTPOST /api/public/apps/track
- POSTPOST /api/public/apps/page
- POSTPOST /api/public/apps/screen
- POSTPOST /api/public/apps/batch
- POSTPOST /api/public/webhooks/segment
- GETGET /api/admin/content/templates
- PUTPUT /api/admin/content/templates
- DELDELETE /api/admin/content/templates
- GETGET /api/admin/segments/
- PUTPUT /api/admin/segments/
- DELDELETE /api/admin/segments/
- GETGET /api/admin/user-properties/
- PUTPUT /api/admin/user-properties/
- DELDELETE /api/admin/user-properties/
- GETGET /api/admin/journeys/
- PUTPUT /api/admin/journeys/
- DELDELETE /api/admin/journeys/
- PUTPUT /api/public/subscription-management/user-subscriptions
- GETGet /api/admin/users/subscriptions
- POSTPOST /api/admin/users/
- DELDELETE /api/admin/users/
- GETGET /api/admin/events/
- POSTPOST /api/admin/broadcasts/execute
- PUTPUT /api-l/admin/workspaces/child
- DELDELETE /api-l/admin/workspaces
- GETGET /api-l/admin/workspaces/
- POSTPOST /api-l/sessions/
API Reference
POST /api/admin/broadcasts/execute
Create and trigger a broadcast.
POST
/
api
/
admin
/
broadcasts
/
execute
curl --request POST \
--url http://localhost:3001/api/admin/broadcasts/execute \
--header 'Content-Type: application/json' \
--data '{
"workspaceId": "<string>",
"broadcastName": "<string>",
"segmentDefinition": {
"entryNode": {
"type": "Trait",
"id": "<string>",
"path": "<string>",
"operator": {
"type": "Within",
"windowSeconds": 123
}
},
"nodes": [
{
"type": "Trait",
"id": "<string>",
"path": "<string>",
"operator": {
"type": "Within",
"windowSeconds": 123
}
}
]
},
"messageTemplateDefinition": {
"type": "MobilePush",
"title": "<string>",
"body": "<string>",
"imageUrl": "<string>",
"android": {
"notification": {
"channelId": "<string>"
}
}
},
"subscriptionGroupId": "<string>"
}'
{
"broadcastName": "<string>",
"broadcastId": "<string>"
}
Body
application/json
Available options:
Trait
Available options:
Trait
Mobile push template resource
Available options:
MobilePush
curl --request POST \
--url http://localhost:3001/api/admin/broadcasts/execute \
--header 'Content-Type: application/json' \
--data '{
"workspaceId": "<string>",
"broadcastName": "<string>",
"segmentDefinition": {
"entryNode": {
"type": "Trait",
"id": "<string>",
"path": "<string>",
"operator": {
"type": "Within",
"windowSeconds": 123
}
},
"nodes": [
{
"type": "Trait",
"id": "<string>",
"path": "<string>",
"operator": {
"type": "Within",
"windowSeconds": 123
}
}
]
},
"messageTemplateDefinition": {
"type": "MobilePush",
"title": "<string>",
"body": "<string>",
"imageUrl": "<string>",
"android": {
"notification": {
"channelId": "<string>"
}
}
},
"subscriptionGroupId": "<string>"
}'
{
"broadcastName": "<string>",
"broadcastId": "<string>"
}