Campaigns

DELETE `/v1/campaigns/{campaignId}`

Delete a campaign and retire its delivery rows.

Autenticazione

Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`campaignId (path)`	`string`	Sì	—

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`deleted`	`boolean`	Sì	—
`delivery_rows_purged`	`integer`	Sì	—

Errori che questo endpoint può restituire

401 · 403 · 404 · 422

DELETE /v1/campaigns/{campaignId}