Execute

Time	Status	User Agent
Retrieving recent requests…

apptoken

string

required

Your app token

int32

required

ID of the Campaign within Xtremepush

target_by

string

Specify the type of identifier used in target or target_with_params. Allowed values: id (Xtremepush device id - default), user_id (client-defined unique user/contact id), email, mobile_number, profile_id (Xtremepush profile ID), token (push token), or specific mobile OS identifiers: device_adid, device_idfv, device_idfa.

target

array of strings

List of targeted IDs, type defined by target_by. Eg. ["user1", "user2"]

target

target_with_params

json

An alternative to target parameter if you want to pass the values of any personalisation params you have in your campaign template message. Eg. {"user1": {"fname":"Alex","balance":"100 EUR"}, "user2": {"fname":"John", "balance": "80 EUR"}}

target_existing_only

string

Optional. Set to 0 to create a new user profile if the profile didn't exist before.

params

json

Personalisation params used when targeting a single user or all messages are to be modified with the same params. Eg. {"first_name":"Sam","balance":"500"}. Where params are defined they will be applied to all the targeted profiles; any overrides or additional params defined in target_with_params will be merged in or override the default set in params.

time

string

Optional to specify when to execute the campaign. It will be executed immediately if this param is omitted. You can use both date string and unix timestamp as a value.

async

string

Optional. If set to 0 your request will be processed completely before API response is returned. In this way you enable an extra level of error reporting being able to receive errors like: "Recipient not found", "Message is suppressed due to insufficient personalization params". The limitation of non-async mode is that you're only allowed to target a single profile/device. In case you need an extra level of reporting for batch sends you should use a separate query to fetch batch send status.

200200

400400