campaigns

Pause lifecycles

Pause campaigns of any product so no new work starts; work already running finishes. The user must approve. Returns each campaign's outcome: changed, unchanged, blocked (with the reason), missing, or pending.

post/api/v1/campaigns/lifecycles/pause

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/campaigns/lifecycles/pause
  • Auth: OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Point11-Confirm'true' required

Explicit human confirmation of this operation's effect.

Request body

Response

Success.

requestedCountinteger required

Distinct campaigns the command named.

changedCountinteger required
unchangedCountinteger required

Campaigns already in the requested state.

blockedCountinteger required

Campaigns the command cannot change from their current state.

pendingCountinteger required

Campaigns whose deletion waits for running work to stop; it completes without another call.

missingCountinteger required

Named campaigns that do not exist for that product here.

Changes

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