Mutations

Start a mutation

Available on: Meta

Starts a change on a live advertiser and answers immediately.

The change does not happen during this request. The answer carries a workflowId. Poll GET /mutations/{id} with it to find out how the change ended. A Mutation is durable, so the id stays valid across retries and restarts.

A refused request starts nothing. AdCrunch refuses a body that does not match, an advertiser that is not yours, an advertiser with no usable connection, and an advertiser connected without write access before a Mutation exists. So a failed call leaves no row in the history.

This operation checks the credential first and the body second. A missing or unusable credential answers 401 even when the body is wrong as well. A body that does not match then answers 400 with error of invalid_request, and issues names each field.

A create never starts delivery: a campaign, an ad set and an ad all arrive paused, and so does a copy of a campaign or an ad set. This API also cannot delete, so meta_set_status with ARCHIVED is how an object is retired.

post/mutations

Request

  • Base URL: https://api.adcrunch.dev
  • URL: https://api.adcrunch.dev/mutations
  • Auth: HTTP bearer

Request body

advertiserIdstring required

The advertiser to act on, as an AdCrunch acc_ id. It must belong to your organization and be connected with write access.

Example request

{
  "action": {
    "id": "120210000000000",
    "kind": "meta_set_status",
    "level": "campaign",
    "status": "PAUSED"
  },
  "advertiserId": "acc_1203456789012345"
}

Response

The Mutation started. Poll it for the outcome.

workflowIdstring required

The id of the Mutation. Poll GET /mutations/{id} with it to find out whether the change succeeded.

Example response

{
  "workflowId": "b3d1f0c4-6a2e-4a1f-9f77-2c0d1e5a8b94"
}

Changes

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