agency-board
DELETE /v1/agency/boards/{boardId}/invites/{inviteId}
Revoke a share link, and everybody who joined through it.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X DELETE https://api.zinndigital.com/v1/agency/boards/{boardId}/invites/{inviteId} \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
⛔⛔ **This cascades.** Revoking a link also removes the board seats that link created, and the response says how many. That is deliberate and it is what separates revocation from expiry: expiry is a door closing, and nobody already inside is turned out; revocation is *"that link went somewhere it should not have"*, which a closed door does not answer.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
boardId (path) | Uuid | Oui | Project board ID (UUIDv7). |
inviteId (path) | Uuid | Oui | Board share-link ID (UUIDv7). Not the token — see `BoardShareToken`. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
revoked | boolean | Oui | — |
seats_removed | integer | Oui | How many board seats the revocation removed. Reported rather than swallowed: a silent side effect on a destructive action is how somebody removes four people believing they only… |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404