Skip to main content
POST
Start Project

Authorizations

X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. Keys are scoped to your organization hierarchy. A key carries up to three permissions: public:read for GET requests, public:write for POST, PATCH, and PUT requests, and public:delete for DELETE requests. public:delete is only available together with public:write.

Headers

Idempotency-Key
string

Optional idempotency key: a unique string of 16-200 printable ASCII characters (a UUID is recommended). Retrying the write with the same key within 24 hours returns the stored response of the first call with an X-Idempotent-Replayed: true response header instead of executing it again. Reusing a key with a different request body returns 422 (IDEMPOTENCY_MISMATCH); a duplicate sent while the first call is still running returns 409 with a Retry-After header. Keys are scoped per endpoint and organization.

Required string length: 16 - 200

Path Parameters

id
string
required

Resource ID

Body

application/json
audience
enum<string>

Only for a project whose trigger is a tag, and required for its first start (resuming a paused one takes no audience). current_and_new sends to everyone who carries the tag now, entered in the background, and to everyone tagged from then on. new_only sends only to contacts tagged from then on. Any other project returns 400 at audience.

Available options:
current_and_new,
new_only

Response

Project started.

success
boolean
required
data
object
required