Send a campaign push message from Contour to multiple recipients using JSON. Push messages can be sent in a batch to a maximum of 10,000 recipients. During a Marketing sendpush request, the Marketing service checks the push permit of a recipient, updates existing records in the Person table and inserts new records for a new person in the Person table.
Prerequisites
Before you can use this service you need to make sure that you've completed the following tasks:
- Created a schedule in Contour
- Received the relevant credentials from your RedEye account manager
- Person must already exist on the database before a push can be sent
- User needs to have downloaded the app to receive push notifications and be a push app user
- App user should not have the app opened as in-app messaging is not currently supported
Considerations
- Duplicate Batch_IDs are ignored
- Person aliases are not supported
- The push identifier (how we recognise the recipient's profile ID) is email by default; for alternative identifiers (custrefid or username), these need to be requested through your RedEye account manager.
- For specific cases permit override can be allowed, speak to your Account Manager for more information
- We recommend each recipient in the API call should have the same parameters but they can have different values
- If push permit is specified in the API call this should be for every recipient as above, a recipient without permit will be presumed as no permit and will be rejected. If push permit is not included for any recipient then the value will be taken from your database.
URL to use:
METHOD: POST
https://api.redeye.com/[client_id]/marketing/sendpush/Body Sample
{
"schedule": "string", //the name of the schedule to send
"batch_id": "integer", //a unique reference number such as a non-decimal integer
"recipients": [{
"email": "string",
"firstname": "string",
"titlelastname": "string",
"ordernumber": 0
}]
}