Create Push Campaign
create-push-campaignDraft a push notification campaign for app users by targeting lists, tags, and segments; review and send it from the Arsel dashboard.
Instructions
Create a push notification campaign for the organization's app users. The audience is the union of list_ids, tag_ids and segment_ids. Find lists with list-lists and tags with list-tags; segments are managed in the Arsel dashboard. The campaign is saved as a draft. This server cannot send or schedule it: the user does that from the Arsel dashboard.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| name | Yes | Internal campaign name. | |
| title | Yes | ||
| tag_ids | No | Tags to target. | |
| icon_url | No | Small icon, https only. | |
| list_ids | No | Lists to target. | |
| priority | No | ||
| deep_link | No | Opened when the notification is tapped. | |
| image_url | No | Large image, https only. | |
| description | No | ||
| segment_ids | No | Segments to target. | |
| ttl_seconds | No | How long delivery is retried for an offline device. | |
| data_payload | No | Flat string map delivered to the app. Keys reserved by Arsel or Firebase are rejected. | |
| action_buttons | No | ||
| target_platforms | No | Restrict to these platforms; omit for all. | |
| throttle_minutes | No | Spread delivery over this many minutes. | |
| android_channel_id | No | ||
| smart_sending_enabled | No | Skip contacts messaged too recently on this channel. Defaults to true. |