Create

post

https://api.eu.xtremepush.com/api/external/create/campaign

Used to create an automated campaign or create a campaign to be dispatched immediately with the send API method.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

apptoken

string

required

Your App token

title

string

required

The title of your campaign

trigger

int32

The type of campaign to create. Parameter options:
0 - Scheduled campaign (default value)
1 - Geo / iBeacon triggered campaign
2 - Event triggered campaign
3 - Api triggered campaign

category_id

int32

The ID of the engagement category that you want to link to the campaign. A project's configuration may require this parameter to be set.

target_applications

int32

The ID or IDs of the app or site that you want to target. This option needs to be enabled beforehand from Settings > Engagement rules and categories. See our segment tab guide for more details.

boolean

Enable email message channel. Default to 0 (off)

sms

boolean

Enable sms message channel. Default to 0 (off)

android_push

boolean

Enable push message channel on Android. Default to 0 (off)

ios_push

boolean

Enable push message channel on iOS. Default to 0 (off)

ios_push_production

boolean

Enable push message channel for iOS production builds. Default to 0 (off)

ios_push_sandbox

boolean

Enable push message channel for iOS dev builds. Default to 0 (off)

web_push

boolean

Enable web push message channel. Default to 0 (off)

web_push_chrome

boolean

Enable web push messaging for Chrome and Opera. Default to 0 (off)

web_push_firefox

boolean

Enable web push messaging for Firefox. Default to 0 (off)

web_push_safari

boolean

Enable web push messaging for Safari. Default to 0 (off)

inbox

boolean

Enable inbox message channel. Default to 0 (off)

webhook

string

Enable webhook message channel. Default to 0 (off)

encryption

int32

Only applicable — and required to be 1 or 2 — if your project has the encryption feature enabled, and the campaign has the android_push or ios_push channels enabled. Parameter options:
0 - Turned off (default value)
1 - Use where possible
2 - Enforce encryption
More info on encrypted push: https://docs.xtremepush.com/docs/encrypted-mobile-push

Responses

200200

400400