Trigger a campaign

post

https://api.getblueshift.com/api/v1/campaigns/execute

Use this endpoint to trigger an event-triggered or API-triggered campaign for a specific user.

Body Params

Required parameters to trigger a campaign.

string

required

Specify the email address of the user for whom you want to trigger the campaign.

campaign_uuid

string

required

Specify the UUID of the campaign that you want to trigger. You can copy the UUID from the URL of the campaign on the Blueshift app. For example, if you open a campaign in the Blueshift app, its URL looks like https://app.getblueshift.com/dashboard#/app/campaigns/<CAMPAIGN_UUID>/details.

email_attachments

array of strings

Specify the URLs of the files that you want to send as an attachment along with the email.

email_attachments

_bsft_high_priority

boolean

Defaults to false

Set to true if the campaign must be processed as a high priority campaign. Blueshift first processes all high priority campaigns in a first in first out order. This is followed by all other campaigns in a first in first out order. The default value is false.

transaction_uuid

string

Optionally include the transaction UUID (must be a well formed UUID) to avoid duplicate messages. The API returns a 200 status code for a duplicate request along with a message noting that a request with the given transaction UUID was already processed.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request - The request is invalid due to missing or incorrect parameters. This includes missing fields, invalid values, formatting issues, or conflicts such as duplicate data.

401Unauthorized - API authentication failed due to an invalid or missing API key.

403Forbidden - The API key does not have sufficient permissions to perform this action.

404Not Found - The specified campaign was not found. Verify the campaign UUID.

422Unprocessable Entity - Request validation failed. Common reasons include: campaign is not event/API triggered (error_code: 101), campaign cannot be triggered through this endpoint (error_code: 102), or a valid user identifier is missing (error_code: 102).

429Too Many Requests - The request limit has been exceeded. Reduce request frequency.

500Internal Server Error - An unexpected server error occurred. Contact support if the issue persists.

502Bad Gateway - The server received an invalid response. Retry the request.

503Service Unavailable - The service is temporarily unavailable. Try again later.

504Gateway Timeout - The server took too long to respond. Retry the request with exponential backoff.