patch https://api.getblueshift.com/api/v1/campaigns//launch
Use this endpoint to launch a campaign. Archived or completed cannot be launched. The launch API will return any errors typically displayed on the UI during a campaign launch.
Launch campaign
Use this endpoint to launch an existing campaign programmatically. This endpoint allows marketers to initiate campaigns based on specific statuses and predefined conditions.
Consider the following points before using the API:
-
Campaign status:
- Campaigns with a status of
archived
orcompleted
cannot be launched. - Campaigns already in an
executing
orlaunched
state cannot be relaunched.
- Campaigns with a status of
-
Error handling:
- The API returns any warnings or errors encountered during the launch process, similar to those shown on the dashboard.
Note
You can find the campaign_uuid (campaign ID) in the campaign editor's URL.
Try it out:
- Add the user API key as the username and leave the password field blank.
- Select your base URL and API endpoint URL for the appropriate Blueshift region.
- Click Try It.
You can also try the API using Blueshift's API collection in Postman.