Campaigns

DELETE /v1/campaigns/{campaignId}

Delete a campaign and retire its delivery rows.

Všechny koncové body Campaigns

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

curl -X DELETE https://api.zinndigital.com/v1/campaigns/{campaignId} \
  -H "Authorization: Bearer zdk_live_…"

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

Delete a draft campaign. A campaign that has started sending cannot be deleted — cancel it instead, so its delivery history survives.

Parametry

NázevTypPožadovánoCo to je
campaignId (path)stringAno

Odpověď

NázevTypPožadovánoCo to je
deletedbooleanAno
delivery_rows_purgedintegerAno

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422