Use API keys

Authenticate requests to the Blueshift API using your API key.

The Blueshift API uses HTTP Basic Authentication. Pass your API key as the username and leave the password blank. Most HTTP clients handle the Base64 encoding for you.

Use the Event API key for event ingestion and supported live-content endpoints. Use the User API key for everything else. See Generate API keys if you don't have your keys yet.

Example: trigger a campaign with curl

The -u flag handles Basic Auth. The trailing colon after the key represents the empty password:

curl -X POST https://api.getblueshift.com/api/v1/campaigns/execute \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -u <USER_API_KEY>: \
  -d '{
    "email": "<EMAIL_ADDRESS>",
    "campaign_uuid": "<CAMPAIGN_UUID>"
  }'

Next steps

  • For full authentication details — including base URLs by region, manual Authorization headers, and Try It console steps — see Authorization.
  • Browse the API reference for the full list of endpoints.
💬

Need help? For support, see Get in touch.