Activate or Deactivate Campaign Groups (Bulk)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Activate or deactivate up to 1,000 campaign groups in a single request. The endpoint accepts a list of ActivationEntity objects.

The optional is_atomic query parameter (default true) controls how failures are handled:

is_atomicBehavior
trueThe entire batch is rejected on any single entity failure.
falseFailed entities are skipped; successful entities are still applied.

The response is the list of successfully-updated campaign groups.

ActivationEntity fields

FieldModifierTypeDescription
idRequiredLongUnique ID of the entity (account or campaign group).
is_activeRequiredBooleanRequested state after the action.
entity_typeRequiredEnumOne of: ADVERTISER, CAMPAIGNS_GROUP.

Failure behavior reference

Caseis_atomic: trueis_atomic: false
User lacks batch activation permissionForbiddenForbidden
User not allowed on at least one entity's accountForbiddenForbidden
Entity is missing required fieldsMissing FieldSkips entity
Entity not foundNot FoundSkips entity
Activating a stopped entityBad RequestSkips entity

Example - Activate multiple entities

POST /backstage/api/1.0/entities/activations?is_atomic=true
{
  "collection": [
    { "id": 123123, "is_active": true, "entity_type": "ADVERTISER" },
    { "id": 34123,  "is_active": true, "entity_type": "CAMPAIGNS_GROUP" }
  ]
}
{
  "collection": [
    { "id": 123123, "is_active": true, "entity_type": "ADVERTISER" },
    { "id": 34123,  "is_active": true, "entity_type": "CAMPAIGNS_GROUP" }
  ],
  "metadata": {}
}

Failure response

{
  "http_status": 400,
  "message": "Missing required field",
  "offending_field": "entity_type",
  "message_code": "api.action.bad_request.entityType"
}
Query Params
boolean
Defaults to true

If true (default), the whole batch fails on a single error. If false, failed entities are skipped.

Response
200

200

Language
Credentials
OAuth2
LoadingLoading…