Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Next »


Last Updated: Wednesday, January 31, 2018



Create Mobile Wallet Message

The following will create a new Wallet message and immediately begin sending it out to the targeted Wallet items.

POST /companies/:company_id/campaigns/wallet/:wallet_id/messages

The created_at, updated_at, url, and wallet_message_id fields are system generated. Any values specified in the request will be ignored.


Notes:

  • Messages based on location (Latitude/Longitude) can be sent for Apple and Android, but time-based notifications can only be sent for Apple.
  • An HTTP 200 status code means that an OK result will be returned if the operation completes successfully.
  • An HTTP 404 - Not Found error will be returned if the specified Mobile Wallet :wallet_id does not exist.


Request JSON

{
   "message":{
      "template":"This is the updated message I would like to send.",
      "header":"Header, for Android Pay only.",
      "image_url":"http://www.google.com/wallet.jpg"
   },
   "campaign_ref":{
      "id":"abCDefGHij",
      "type":"Loyalty",
      "url":"/companies/:company_id/campaigns/wallet/abCDefGHij"
   },
   "filters":[
      {
         "name":"group_code",
         "selector":"starts_with",
         "value":"DEA"
      },
      {
         "name":"providers",
         "selector":"any",
         "value":[
            "Passbook"
         ]
      }
   ]
}

Return JSON

A Wallet message entity reflecting the message created.

  • No labels