notifications

DELETE /v1/notification-connections/{connection_id}

Disconnect a destination.

Alle notifications Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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.

Parameter

NameTypErforderlichWas es ist
connection_id (path)stringJa
org_id (query)stringNeinThe 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…

Antwort

NameTypErforderlichWas es ist
deletedbooleanNein
credential_removedbooleanNeinWhether 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…