We currently only support GET requests for pulling information into your own website or app. More endpoints will be coming in the future but if you
require a custom endpoint please contact us.
Authentication
All API endpoints are authenticated using Bearer tokens. This Bearer token will be provided to you when you reach out to our support. To authenticate your requests, you need to include the Bearer token in the header of your request.Base URL
There are two environments. Requests default to staging, which is where you should build and test your integration.
Both expose the same endpoints and the same authentication scheme, so moving between them is a change of base URL and nothing else.
API keys are issued per environment, so you will be given a separate key when you are ready to go live. Use the key you were issued for the
environment you are calling. Campaigns and the malls they belong to differ between the two environments as well, so expect different results from
the same request.
Rate Limiting
We allow a maximum of 1000 requests per minute. The limit is applied per API key rather than per IP address, so your quota is yours alone and is not affected by other customers. If you exceed it you will receive a429 Too Many Requests response, so your integration should handle that status rather
than treating it as a hard failure.
Every response carries the current state of your quota in the standard RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset headers, which
you can use to pace your requests. If you require a higher limit, please contact us.
Publishing Campaigns To Your Web Channel
Retrieving a campaign through this endpoint is what marks it as published to your website. When a campaign is returned to you, it is automatically approved for the Mobile Site/Website channel and recorded against your account, on the basis that having received it you are about to display it.Because of this, requests are not side effect free. Avoid calling the endpoint from contexts where you are not actually going to display the results
- link previews, uptime checks or speculative prefetching, for example - and prefer caching a response you already hold over re-requesting it.
ISO Codes
In the responses, you will see that theheadline, description and imageUrls fields are returned in multiple languages. Below you can find a table
of our ISO codes and what languages they represent.
Campaign Types
When querying Marketing Campaigns, you can filter the results by specific campaign types using thetype query parameter.
By default, if no type is provided, campaigns of all types will be returned.
If you’re only interested in certain types, simply include one or more type parameters in your query. For example:
Tip: URL encoding is handled automatically by most tools (such as Swagger UI, Postman, Mintlify). However, if manually crafting a URL, remember to
encode special characters like a space (’ ’) as
%20 and slashes (’ / ’) as %2F. For example, when selecting New Arrivals, the URL becomes: