Authentication
All API requests require authentication using a Bearer token. Include your API token in theAuthorization header of each request.
How to get your API token
Learn how to generate and manage your Smart Send API token.
User-Agent header
We recommend including a descriptiveUser-Agent header with every API request. This helps us identify your integration and is invaluable when debugging issues on your behalf.
Follow the Product/Version (Comments) pattern established by RFC 7231. Include your application name and version, along with any relevant platform details in the comments.
Example
WooCommerce plugin example
Without a descriptive
User-Agent, your requests appear as anonymous traffic, making it much harder for our support team to trace and resolve issues.Request-ID header
We recommend including a uniqueRequest-ID header with every API request. The API echoes the same value back in the response Request-ID header, making it possible to correlate requests between your system and Smart Send.
The Request-ID is included in our internal logs, so when you contact support about a specific request, providing the Request-ID lets us trace it through our systems quickly.
Example
Use any string up to 128 characters containing letters, numbers, dots, hyphens, or underscores. A UUID or a descriptive key tied to your business logic both work well.