Campaigns

DELETE `/v1/campaigns/{campaignId}`

Delete a campaign and retire its delivery rows.

Упълномощаване

Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

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

Параметри

Име	Тип	Задължително	Какво представлява
`campaignId (path)`	`string`	Да	—

Отговор

Име	Тип	Задължително	Какво представлява
`deleted`	`boolean`	Да	—
`delivery_rows_purged`	`integer`	Да	—

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422

DELETE /v1/campaigns/{campaignId}