v1

latestOpenAPI 3.0.02026-07-267581167.5 KB

Wallet Messaging API

Create a wallet message

post/companies/{company_key}/campaigns/wallet/{wallet_id}/messages

Path parameters

company_keystring required

wallet_idstring required

The wallet_id is the SmartLink token for a campaign.

<div style="color:#dd1e2e; background:url(https://d2xs7zaan7w9gl.cloudfront.net/data/pages/64014/widgets/48027d01-e827-45e0-b96d-227c1099eedc/image/1680214872.png?icon-24x24-warning.png) no-repeat 10px center; background-color:#FCEAEC; padding:10px; font-size:13px;"><div style="padding-left:35px"><b>Important:</b> If you are entering a real wallet_id, please note that using the <b>"Try It"</b> feature on the righthand console will send an actual API call to our system. This may result in a wallet message being created and sent.</div></div>

Headers

X-API-Versionstring

Content-Typestring required

Request body

Example request

{
  "message": {
    "header": "Reminder",
    "template": "Your Spring Sale offer expires soon!"
  },
  "filters": [
    {
      "name": "group_code",
      "selector": "=",
      "value": "vip"
    }
  ]
}

Response

Successful response

wallet_message_idstring

Unique system-generated identifier for each message created.

created_atstring

When the message was created, in ISO-8601 format.

updated_atstring

When the message was last updated, in ISO-8601 format.

urlstring

A reference URL to this message, as a relative URL on the API domain.