Campaigns

DELETE `/v1/campaigns/{campaignId}`

Delete a campaign and retire its delivery rows.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

Nome	Tipo	Obrigatório	O que é
`campaignId (path)`	`string`	Sim	—

Resposta

Nome	Tipo	Obrigatório	O que é
`deleted`	`boolean`	Sim	—
`delivery_rows_purged`	`integer`	Sim	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 422

DELETE /v1/campaigns/{campaignId}