campaigns

Update campaign status

Transport: call this endpoint with HTTP PATCH and a JSON request body. Update campaign status. Activating a campaign requires an approved campaign_activate confirmation_id. Draft and paused campaigns may activate after validation and approval. Active campaigns may pause or enter supported terminal states. Completed, failed, canceled/cancelled, rejected, and processing campaigns cannot be activated and return CAMPAIGN_INVALID_STATUS_TRANSITION. For API automation, stage that confirmation with confirmations.requestAction. If Autopilot approves it, activate immediately with the returned confirmation_id; otherwise wait for browser approval.

patch/v1/campaigns/updateStatus

Request

  • Base URL: https://api.zevari.ai
  • URL: https://api.zevari.ai/v1/campaigns/updateStatus
  • Auth: HTTP bearer

Request body

campaign_idstring required

Campaign ID

status'active' | 'paused' | 'completed' | 'failed' required

New status

fail_reasonstring

Reason for failure (when status=failed)

confirmation_idstring

Required when status='active'. First call confirmations.requestAction with action_type='campaign_activate' and payload={campaign_id}. If the response includes data.autopilot.approved=true, retry campaigns.updateStatus immediately with this confirmation_id. Otherwise use data.approval_url for browser approval, then retry with the same confirmation_id.

Response

Successful Zevari API response.

okboolean required

False when the underlying tool reports an error or a partial failure.

methodstring required

Public API method name.

dataunknown required
request_idstring required

Request correlation ID. Also returned in X-Zevari-Request-Id.

Example response

{
  "method": "campaigns.delete"
}

Changes

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