Trigger a campaign

API at a glance

Description: Use this endpoint to trigger an event-triggered or API-triggered campaign for a specific user. This API allows you to programmatically send transactional or event-based campaigns.

🚧

Note

The endpoint works for campaigns that are set to trigger using an API call. In an event triggered campaign, in the Journey Start trigger, set When event occurs to API Endpoint is called.

Try it out

1. Add the User API key as the Username and leave the Password field blank.
2. Click the Base URL dropdown and select the API endpoint URL for your Blueshift region.
3. Click Try It.

You can also try the API using Blueshift's API collection in Postman.

Things to know before you start

• This endpoint works only with campaigns configured as event-triggered or API-triggered.
• The campaign must have triggering_event_name left blank (for API-triggered) or match the event you're sending.
• Required identifier: You must provide a valid user identifier (email, customer_id, or other configured identifier).
• Email attachments: Attachment URLs must be publicly accessible.
• Transaction UUID: Use this to prevent duplicate messages. Blueshift returns 200 OK for duplicate requests with the same transaction_uuid.
• Use case: Best for sending transactional emails (order confirmations, password resets) or triggering event-based campaigns via API.

Finding the campaign UUID

You can find the campaign UUID in the URL of the campaign editor in the Blueshift app.

Request parameters

Example requests & responses

{
  "email": "[email protected]",
  "campaign_uuid": "a43b685d-65e3-5303-64d8-d4b4ab075b5f"
}

{
  "success": true
}

{
  "email": "[email protected]",
  "campaign_uuid": "a43b685d-65e3-5303-64d8-d4b4ab075b5f",
  "email_attachments": [
    "https://cdn.getblueshift.com/examples/sample.pdf",
    "https://cdn.getblueshift.com/static/csv/test.csv"
  ],
  "_bsft_high_priority": false,
  "transaction_uuid": "a0d1a0f3-6596-4e1c-b487-3639e05b6d2f"
}

{
  "success": true
}

{
  "email": "[email protected]",
  "campaign_uuid": "a43b685d-65e3-5303-64d8-d4b4ab075b5f",
  "_bsft_high_priority": true,
  "transaction_uuid": "b1e2f4g5-7890-5e2f-c598-4740f96e7c3a"
}

{
  "success": true
}