notifications
DELETE /v1/notification-connections/{connection_id}
Disconnect a destination.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی org_id را به عنوان یک پارامتر پرسوجو میپذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجارهای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.
شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواستهایی که ارسال میکنید یکسان است.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X DELETE https://api.zinndigital.com/v1/notification-connections/{connection_id} \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
Removes the destination, its routing cells, and its stored credential. The credential is removed from the vault FIRST and the result is reported rather than assumed: if the row went first and the vault delete failed, a live Slack token or webhook secret would be orphaned under a path no row names - un-enumerable, which is worse than a leak you can list.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
connection_id (path) | string | بله | — |
org_id (query) | string | خیر | The organization to act on. Omitted resolves to your own ONLY when you belong to exactly one organisation; a principal in more than one must name it, or the call is refused `422… |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
deleted | boolean | خیر | — |
credential_removed | boolean | خیر | Whether the stored credential was actually removed. False means the vault could not be reached - the destination is gone but an operator must clean up. Reported rather than sile… |