Launch a Campaign

POST /v1/campaigns/{campaign_id}/launch

Launches a draft (1.65.0; sections 3.8 and 7.3): every launch check runs and each failure is an issue of one 422 validation_failed (CampaignIssueCode), among them campaign_attestation_required without an attestation in force and campaign_budget_required without a budget; a test Campaign on phone is environment_not_allowed. A launch that passes pins each arm's active version, freezes revision 1, starts the supervisor and answers the Campaign scheduled before start_at, running after. A Campaign that is not a draft is campaign_conflict (not_draft).

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the campaigns:launch scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/campaigns/cmp_.../launch" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/campaigns/cmp_.../launch`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/campaigns/cmp_.../launch",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: CampaignReasonRequest.

Responses

Fields of the 200 answer

The shape is Campaign.