APappier

Approve or Reject a Campaign

Approve or reject a campaign.

post/api/v1/campaigns/{campaignId}/update

Request

  • Base URL
    https://api.enterprise.appier.net
  • URL
    https://api.enterprise.appier.net/api/v1/campaigns/{campaignId}/update
  • Auth
    API key in header appId and API key in header Authorization

Path parameters

campaignIdinteger required
Example:123456

The numeric ID of the campaign to approve or reject, for example, "123456". To find it, edit the campaign in the AIQUA dashboard and copy the number at the end of the page URL, without any prefix or trailing slash.

Request body

action'approve' | 'reject' required

The action to take on the campaign. Case-sensitive.

reasonstring nullable

The rejection reason, up to 1,000 characters. The reason is saved for rejections only. An empty string or null is accepted.

Example request

{
  "action": "reject",
  "reason": "The reason for rejecting the campaign."
}

Response

The campaign was approved or rejected.

campaignIdinteger

The ID of the campaign.

requestIdstring

A trace ID for this request, not an idempotency key. It matches the X-Request-ID response header. Include it when you contact Appier Support (ess_support@appier.com) or your customer success manager.

status'Approved' | 'Rejected'

The result of the action. This isn't the campaign's current delivery or display status.

statusChangedAtstring date-time

When the action was accepted, in ISO 8601 format.

statusChangeSource'API'

Where the action came from. Always "API" for this endpoint.

Example response

{
  "campaignId": 123456,
  "requestId": "0fd10467-a54d-4f52-b21e-c42e944fa87c",
  "status": "Approved",
  "statusChangedAt": "2026-09-23T03:00:00+00:00",
  "statusChangedBy": {
    "type": "apiToken",
    "id": "tok_0123456789ab",
    "name": "CRM Integration"
  },
  "statusChangeSource": "API"
}

Changes

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