API at a glance
Description: Use this endpoint to pause 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_valueYou 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 paused:
archivedcompleted
-
Use case: Best for temporarily stopping campaigns due to internal reviews, content issues, or emergency holds.
Finding the campaign UUIDThe campaign UUID is visible in the browser's address bar when you open a campaign. For example:
https://app.getblueshift.com/dashboard#/app/campaigns/<CAMPAIGN_UUID>/edit_v3/journey
Request parameters
Check out the request parameters
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_uuid | string | ✅ Yes | UUID of the campaign to pause. |
Specify the UUID of the campaign to pause. 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
Pausing a campaign
curl --request PATCH \
--url https://api.getblueshift.com/api/v1/campaigns/8e2ef617-5931-4175-8485-e31a5c1bd8d8/pause \
--header 'accept: application/json' \
--header 'authorization: Basic MmI1ZDM2MDI3ZWMzMWFhNzJlN2Y3NjA3OThlMzZlZDk6'{
"uuid": "8e2ef617-5931-4175-8485-e31a5c1bd8d8",
"status": "paused",
"updated_at": "2025-07-20T10:17:56.042Z"
}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.
Unauthorized - API authentication failed due to an invalid or missing API key.
Forbidden - The API key does not have sufficient permissions to perform this action.
Not Found - The specified campaign was not found. Verify the campaign UUID.
Unprocessable Entity - The campaign cannot be paused due to its current status (e.g., already completed or archived). One or more scheduling parameters may be invalid (if applicable).
Too Many Requests - The request limit has been exceeded. Reduce request frequency.
Internal Server Error - An unexpected server error occurred. Contact support if the issue persists.
Bad Gateway - The server received an invalid response. Retry the request.
Service Unavailable - The service is temporarily unavailable. Try again later.
Gateway Timeout - The server took too long to respond. Retry the request with exponential backoff.