Start checkout for a reviewed batch campaign

Human only: A signed-in owner or admin does this in the browser at gtmswag.com. API keys and OAuth connections receive 403 HUMAN_APPROVAL_REQUIRED with a url to hand to that person. Hand the campaign review URL to them. Starts a Stripe checkout for the reviewed people without a gift; playbooks are paid from the balance instead (409 ALWAYS_ON_BALANCE_FUNDED).

post/campaigns/{id}/checkout

Request

Base URL: https://gtmswag.com/api/v1
URL: https://gtmswag.com/api/v1/campaigns/{id}/checkout
Auth: API key in cookie gtm_session

Path parameters

idstring required

Campaign or playbook ID (cmp_).

Request body

expectedPolicyVersioninteger required

The campaign's current policyVersion; a stale value returns POLICY_CHANGED.

idempotencyKeystring required

Same key for identical retries only.

Response

Success: {"data": Checkout}.

Changes

No recorded changes to this operation across all 1 revision of this API.