Skip to contentDevelopersPrezly website
Campaigns

Send campaign

Submit a reviewed draft campaign for asynchronous sending.

Personal token scopes: campaigns:send. Your account must also have access to the requested data. Authentication

Read the guide

POST
/campaigns/{id}/send
  • It is only allowed to send a draft campaign. Otherwise an error will be thrown (Forbidden 403).

Personal access tokens: campaigns:send. Every listed scope is required; the token owner's permissions, feature availability and newsroom access still apply.

Authorization

API_key
headerAuthorizationBearer <token>

Bearer authentication using an integration API key, or a personal access token only where the operation explicitly supports it. Every listed personal-token scope is required; owner permissions and newsroom access still apply.

Path Parameters

id*number

Campaign ID

Response Body

Accepted

application/json
  1. response

Such responses are returned when the request was validated and understood, but is too large to fulfill within the response timeout. In that case a background job is pushed and a 202 Accepted response is generated containing Job ID. Job ID can be used with Jobs API to check status for.

status*"accepted"
Value in"accepted"
progress*

Background Job Reference object

Example Request
curl -X POST 'https://api.prezly.com/v2/campaigns/0/send'
Example Response202
{  "status": "accepted",  "progress": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "links": [      "http://example.com"    ]  }}