v1

latestOpenAPI 3.0.02026-07-267581167.5 KB

Wallet Store Locations API

Bulk create store locations

Add store locations to a wallet campaign in a single request (up to 1000 per call). The Idempotency-Key header is required: repeating a request with the same key returns the original result without inserting duplicates.

post/companies/{company_key}/campaigns/wallet/{token}/locations/bulk

Path parameters

company_keystring required

tokenstring required

The token is the SmartLink token (wallet_id) for the campaign.<br><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> Using the <b>"Try It"</b> feature on the righthand console will send an actual API call to our system. This may result in store locations being created.</div></div>

Headers

X-API-Versionstring

Content-Typestring required

Idempotency-Keystring required

Unique key (up to 255 characters) that makes the request safe to retry without creating duplicate locations.

Request body

Example request

{
  "locations": [
    {
      "location_id": "store-001",
      "name": "Downtown",
      "address": "123 Main St",
      "city": "Chicago",
      "state": "IL",
      "zip": "60601",
      "latitude": "41.8781",
      "longitude": "-87.6298",
      "notification_message": "Stop by the downtown store!"
    }
  ]
}

Response

The store locations were created.