Delete multiple campaigns

Delete several campaigns in one call. This is the v3 equivalent of the v1 campaign_delete_list action.

The body selects what to delete, in one of three shapes:

  • {"ids": [1, 2]} — the given campaigns
  • [1, 2] — a bare array of ids, equivalent to the above
  • {"deleteFirst": 5} — the oldest N campaigns in the account, where N is between 1 and 10

ids and deleteFirst are mutually exclusive.

Deletion is not transactional: campaigns are removed one at a time, so a call can partially succeed. deleted lists the ids that were removed and failed the ids that were not, each with a reason. When nothing at all could be removed the request answers 404.

Requires permission to delete campaigns, and the account must have the Campaigns module enabled.

Body Params
ids
array of int32s

IDs of the campaigns to delete. Must be a non-empty list of positive integers.

ids
int32

Delete the oldest N campaigns in the account, between 1 and 10. Mutually exclusive with ids.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json