Skip to main content
POST
Trigger a content pipeline run

Authorizations

Authorization
string
header
required

Headers

X-Workspace-Id
string<uuid>
required

UUID of the workspace to act in. Take it from GET /me (workspaces[].id). A key scoped to specific workspaces is rejected with 403 WORKSPACE_NOT_ALLOWED for any other id; a missing header is 400 WORKSPACE_REQUIRED.

Body

application/json

Provide either briefIds (optionally with locales for cross-product expansion) or pre-resolved pairs of (briefId, locale). The two variants are mutually exclusive.

briefIds
string<uuid>[]
required
Minimum array length: 1
locales
(string | null)[]
pipelineReleaseId
string<uuid>
triggerType
enum<string>
Available options:
user,
api,
scheduled
metadata
object

Response

Run queued; use the returned jobId to poll for completion

data
object
required
poll
string
required
Example:

"/api/v1/jobs/<jobId>"