Use this REST API to send simple, published push messages to contact lists.
How It Works
Note: Push to Contact Source/Segment APIs do honor mobile app frequency limits.
Prerequisites to API push send
- The Org must have push enabled by provisioning.
- A database in the org must have push enabled.
- An app needs to exist and be made available to mobile devices with specialized code included.
- Said app needs to be installed on a mobile device with push enabled, which triggers consent with Watson Campaign Automation.
- An org admin user with push enabled and a token is the user that intends to make the API calls.
- A user created a simple push message that is published on this org.
Once this has been set up, the user can send a simple published push message to a contact source.
The API user builds an app to do the things that are needed, but if an app isn’t built or ready, one can always use a tool like Swagger to explore the capability of this API.
What must be provided to the API call
The API user must know and supply the following information in the call:
- Published Message ID (parameter = publishedMessageId). The ID of the published message must be provided. All publishable push message types are supported with this API.
- Message Name (parameter = messageName). The API requires a value for message name. It must be unique.
The API user can choose to include the following information in the call as well:
- Contact Source ID (parameter = contactSourceId). The contact source’s ID must be provided. It can be a database, query, or contact list, and it must be enabled for push (or associated with a database that is enabled for push, if a query or contact list).
Campaign Name (parameter = campaignName). While the published push message requires a Campaign Name, the API accepts an optional value that overrides the value in the published push message.
- If a campaign name element is not provided in the API call, the name element in the published push message is used. Whichever one is used ends up in the sent push message UB attribute for campaign name that is used downstream for tracking/reporting.
Recipient Time Zone (parameter = useRecipeintTimeZone). This optional parameter can be used when scheduling a message. Valid values are “true” or “false”.
- True– The time specified in the scheduleDate parameter is converted to each recipient’s time zone.
Note: If scheduled time has already passed for a recipient’s time zone, they will be sent the message immediately.
- False – The time specified in the scheduleDate parameter reflects the time zone configured in the user profile.
Note: The table is an example of the optional time zone parameter.
useRecipientTimeZone True False (or blank) User (Marketer) Time Zone Pacific Pacific Recipient 1 Time Zone Pacific Pacific Recipient 2 Time Zone Eastern Eastern Schedule Time 9:00 am 4/25/2017 9:00 am 4/25/2017 Recipient 1 Send Time 9:00 am Pacific 4/25/2017 9:00 am Pacific 4/25/2017 Recipient 2 Send Time 9:00 am Eastern 4/25/2017 12:00 pm Eastern 4/25/2017