Use this endpoint to immediately launch a campaign.
Campaigns that are archived or already completed cannot be launched. The API returns validation errors similar to those shown on the campaign UI.
API at a glance
Description: Use this endpoint to launch an existing campaign programmatically.
Supported campaign types: All campaign types except completed
and archived
.
Authentication & testing
Testing the API on this page
How to try it here
- Use your User API Key as the Username (leave Password blank).
- Select the appropriate API endpoint based on your Blueshift region.
- Enter the necessary parameters and click Try It to run the request.


Authentication using Base64 encoding
Note for developers
API requests require authentication using HTTP Basic Authentication with an API key.
The API key serves as the username, while the password field should be left empty.
The format to encode is: your_api_key:
(note the trailing colon).
This string must be Base64-encoded and included in the request's Authorization header as follows:
Authorization: Basic encoded_value
You can generate the encoded value using a trusted Base64 encoder.
Postman collection
Try it with Postman: Explore the API using Blueshift's Postman collection.
Things to know before you start
-
Campaigns with the following statuses cannot be launched:
archived
completed
executing
(already running)launched
(already launched)
-
The API returns any errors or warnings that would typically appear in the campaign editor.
-
Use case: Best for programmatically launching campaigns without using the Blueshift UI.
Request parameters
Check out the request parameters
Path parameters
Parameter | Type | Required | Description |
---|---|---|---|
campaign_uuid | string | ✅ Yes | UUID of the campaign to launch. |
Specify the UUID of the campaign to update. You can find the campaign UUID in the URL of the campaign editor.

Request body
Note: No request body is required for this endpoint.
Example requests & responses
Launching a campaign
curl --request PATCH \
--url https://api.getblueshift.com/api/v1/campaigns/09d6d2b1-684b-41c7-80d5-7001ce2653ac/launch \
--header 'accept: application/json' \
--header 'authorization: Basic MmI1ZDM2MDI3ZWMzMWFhNzJlN2Y3NjA3OThlMzZlZDk6'
{
"uuid": "09d6d2b1-684b-41c7-80d5-7001ce2653ac",
"status": "launched",
"updated_at": "2025-06-18T08:11:04.498Z"
}
API error responses
Note
The following error codes are commonly returned by Blueshift APIs. Depending on the specific endpoint, not all may apply.
Status code | Description | Example responses |
---|---|---|
400 Bad 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. | { "errors": { "name": ["can't be blank"] } } { "errors": { "startdate": ["can't be blank"] } } |
401 Unauthorized | API authentication failed due to an invalid or missing API key. | { "message": "Not authorized" } |
403 Forbidden | The API key does not have sufficient permissions to perform this action. | { "message": "Permission denied" } |
404 Not Found | The specified campaign was not found. Verify the campaign UUID. | { "message": "Campaign not found" } |
422 Unprocessable Entity | One or more schedule parameters are invalid or not supported. | { "message": "Invalid schedule values" } |
429 Too Many Requests | The request limit has been exceeded. Reduce request frequency. | { "message": "Rate limit exceeded" } |
500 Internal Server Error | An unexpected server error occurred. Contact support if the issue persists. | { "message": "Internal Server Error - Please contact support for more information." } |
502 Bad Gateway | The server received an invalid response. Retry the request. | { "message": "Bad Gateway - Please retry the request." } |
503 Service Unavailable | The service is temporarily unavailable. Try again later. | { "message": "Service Unavailable - The service is temporarily unavailable. Try again later." } |
504 Gateway Timeout | The server took too long to respond. Retry the request with exponential backoff. | { "message": "Gateway Timeout - The server took too long to respond. Retry with exponential backoff." } |