Campaigns

DELETE `/v1/campaigns/{campaignId}`

Delete a campaign and retire its delivery rows.

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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

Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз

Мәліметтер

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

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`campaignId (path)`	`string`	Иә	—

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`deleted`	`boolean`	Иә	—
`delivery_rows_purged`	`integer`	Иә	—

Бұл соңғы нүкте қайтара алатын қателер

401 · 403 · 404 · 422

DELETE /v1/campaigns/{campaignId}