Add promo codes to promotion

API at a glance

Description: Add new promo codes to an existing promotion. The codes are appended to the promotion's existing promo code list without removing any current codes.

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.

🚧
Number of promo codes in one request
The API can update a maximum of 1000 promo codes per request. If an API call includes more than 1000 promo codes, a 400 error will be returned. To update more than 1000 promo codes, we recommend dividing them into multiple API calls.

Things to know before you start

Adds, not replaces: This endpoint adds codes to existing ones. Use "Overwrite promo codes" to replace all codes.
1000 code limit: Maximum 1000 codes per request. For larger batches, split into multiple API calls.
Promotion UUID required: Get it from the promotion URL in Blueshift app or from the List promotions response.

👍
Finding the promotion UUID
You can find the promotion UUID in two places when viewing a promotion in the Blueshift app:

In the URL: https://app.getblueshift.com/dashboard#/app/promotions/<PROMOTION_UUID>/edit

In the Promotion id field on the promotion edit page

Response counters: Returns available_codes (unused) and total_codes (all codes in promotion).
Duplicate handling: Adding duplicate codes may result in errors or be silently ignored.

Request parameters

Check out the request parameters

Path parameters

Parameter	Type	Required	Description
`promotion_uuid`	`string`	✅ Yes	UUID of the promotion to add codes to

Body parameters

Parameter	Type	Required	Description
`promocodes`	`array`	✅ Yes	Array of promo code strings to add (max 1000 codes per request)

Example requests & responses

Add promo codes to promotion

PUT /api/v1/promotions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_promocodes

{
  "promocodes": [
    "SUMMER2024",
    "SAVE20NOW",
    "FREESHIP"
  ]
}

{
  "available_codes": 6,
  "total_codes": 10
}

Add large batch of codes (approaching limit)

PUT /api/v1/promotions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_promocodes

{
  "promocodes": [
    "CODE_0001",
    "CODE_0002",
    "CODE_0003",
    "...997 more codes...",
    "CODE_1000"
  ]
}

{
  "available_codes": 1000,
  "total_codes": 1000
}

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	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).	`{ "message": "Campaign cannot be paused in its current status." }` `{ "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." }`