Propose: add keywords
Proposes a add_keywords action.
Returns 201 with an actionId and a mode of auto_applied or queued. mode is a decision snapshot, not an outcome: the apply worker re-runs the safe-apply policy before mutating and can still demote an auto-approved action back to proposed. Poll the Location header or the ledger for terminal state.
A queued result is a success, not a failure — the org kill switch, an inactive account, or the 24-hour auto-apply cap all force review rather than erroring.
Required scope: write.
Authorization
bearerAuth An API key from Workspace → Settings → API keys, sent as Authorization: Bearer tsk_….
Authorization has two independent axes.
The scope is ranked — a key satisfies any requirement at or below its own tier:
read— see state. Never changes anything.write— propose changes (theactions/*endpoints), trigger audits and reports.admin— connection, account import, sync, targets and brief.
There is no approve scope. It was a rung once; it is not one now, and a key requested with it is rejected.
The approval grant (can_approve) is a separate boolean, not a rung. Deciding a queued proposal — approve, reject, revert — needs write and the grant. Keeping them on separate axes is what makes the review gate a control rather than a convention: a key that may propose is not automatically a key that may approve its own proposal.
A key is either org-scoped (reaches every account, optionally limited to a subset) or bound to a single account.
In: header
Path Parameters
The account's project UUID — from GET /accounts, NOT the Apple asaOrgId. Pass the literal current with an account-scoped key to use its bound account.
Header Parameters
Send a unique value per logical change. A retry with the same key replays the original proposal (200, Idempotency-Replay: true) instead of creating a second money-moving action.
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/accounts/current/actions/add-keywords" \ -H "Content-Type: application/json" \ -d '{ "adGroupId": "string", "keywords": [ { "text": "string", "matchType": "EXACT" } ], "reason": "stringstri" }'{ "actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0", "kind": "string", "mode": "auto_applied", "decision": "not-applicable", "policyReasons": [ "string" ], "summary": "Set \"Brand US\" daily budget → $150.00 (+20%)", "payload": {}, "currency": "string", "note": "string", "replayed": true}