Skip to content
/Campaigns

Campaigns

Create, configure and coordinate campaigns from published template versions. See each operation for rendering format and generation requirements.

Operations

Create campaign

Request

Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation.

Security
bearerAuth
Headers
Idempotency-Keystring, [ 1 .. 200 ] charactersrequired

Reuse for an uncertain retry of the same intent.

Bodyapplication/jsonrequired
organization_idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
template_idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
template_version_idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
namestring, [ 1 .. 160 ] charactersrequired
curl -i -X POST \
  https://api-docs.shuffll.com/_mock/engage/openapi/v1/campaigns \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -d '{
    "organization_id": "string",
    "template_id": "string",
    "template_version_id": "string",
    "name": "string"
  }'

Responses

Terminal operation job.

Headers
X-Request-Idstring, (uuid)required

Identifier for tracing this response.

Locationstring, (uri)required

Absolute URL of the operation job, from the trusted server origin.

ETagstring

Quoted opaque revision when the resource or job result has one.

Bodyapplication/json
jobobjectrequired
secretAvailablebooleanrequired
Default:false
secretstring
keyobject
Response
{
  "job": {
    "id": "string",
    "command": "string",
    "resourceId": "string",
    "state": "queued",
    "createdAt": "string",
    "updatedAt": "string",
    "result": { … },
    "pollAfterSeconds": 0
  },
  "secretAvailable": false,
  "secret": "string",
  "key": {
    "id": "string",
    "level": "platform",
    "meta_organization_id": "string",
    "organization_id": "string",
    "name": "string",
    "scopes": [ … ],
    "environment": "dev",
    "display_prefix": "string",
    "created_by": "string",
    "issuer_key_id": "string",
    "delegation_allowed": true,
    "created_at": "string",
    "expires_at": "string",
    "revoked_at": "string",
    "last_used_at": "string",
    "revision": "string"
  }
}