Skip to content

Delete Campaign

Deletes a campaign — the Delete row action on the admin Marketing → Communications → Campaigns screen.

TIP

New here? Read the Campaigns overview for what a campaign does and how its fields behave.

Operation

OperationTypePurpose
deleteAdminMarketingCampaignMutationDelete a campaign

Details

  • Requires an admin Bearer token and the marketing.communications.campaigns.delete permission.
  • Pass the campaign's IRI as id. Use the list query to discover valid ids.

Confirm success via the absence of errors

The delete mutation returns a success acknowledgement, not the deleted campaign's data — adminMarketingCampaign resolves to null on the payload. Treat a response with no errors[] as a successful delete. If you need a confirmation message in the body, use the REST endpoint (DELETE /api/admin/marketing/campaigns/{id}), which returns { "message": "Campaign deleted." }.

Input fields

FieldTypeRequiredNotes
idIDYesThe campaign's IRI

Released under the MIT License.