Turn a playbook's auto-approve on or off

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. Keys and connections read the rule as autoApprove on the campaign. Turning it on, or raising perGiftMaxCents or monthlyBudgetCents, needs an owner or admin (403 TEAM_MANAGER_REQUIRED), who becomes the person auto-approvals act for; any teammate may lower the limits or turn it off. Turning it on needs a per-gift limit and a monthly budget (400 MONTHLY_BUDGET_REQUIRED) with the limit within the budget. The playbook keeps its status; its policyVersion increases.

post/campaigns/{id}/auto-approve

Request

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

Path parameters

idstring required

Campaign or playbook ID (cmp_).

Request body

enabledboolean required

true turns auto-approve on; false turns it off.

perGiftMaxCentsinteger

Largest gift (price plus shipping, USD cents) approved without a person, 100 to 100000.

monthlyBudgetCentsinteger

The playbook's monthly spend limit in USD cents; required to turn auto-approve on.

expectedPolicyVersioninteger

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

Response

Success: {"data": Campaign}.

Changes

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