Push campaigns
Broadcast a push notification to your app audience in two steps: create the campaign, then launch it.
Create a campaign
POST /api/apikey/v1/PushCampaignApi/all
| Parameter | Type | Required | Description |
|---|---|---|---|
Name | String | Yes | Campaign name. |
title | String | Yes | Notification title. |
content | String | Yes | Notification body. |
appGuid | String (UUID) | Yes | Target application. |
ClientAccountGuid | String (UUID) | Yes | Client account. |
scheduleDate | Number / null | No | Epoch schedule time; null sends now. |
timeZoneId | String / null | No | Timezone for the schedule. |
imageUrl | String / null | No | Image to display. |
launchUrl | String | No | URL opened on tap. |
Data | Array | No | Custom key/value pairs. |
json
{
"Name": "test push",
"title": "hello world",
"content": "hello world",
"scheduleDate": null,
"appGuid": "<App_Guid>",
"timeZoneId": null,
"imageUrl": null,
"launchUrl": "",
"ClientAccountGuid": "<Client_Account_Guid>",
"Data": [ { "key": "", "value": "" } ]
}
201 Created
json
{ "message": "Success", "code": "8_13_201", "success": true, "data": null, "version": "1" }
Launch a campaign
PUT /api/apikey/v1/PushCampaignApi/campaign-launch
bash
curl -X PUT "https://omni-apis.montymobile.com/notification/api/apikey/v1/PushCampaignApi/campaign-launch" \
-H "api-key: <Your_API_Key>" \
-H "Tenant: <Tenant_ID>" \
-H "Content-Type: application/json" \
-d '{ "CampaignId": "<Campaign_Id>" }'
The launch response body is being finalized. Coming soon