agency-board
DELETE /v1/agency/boards/{boardId}/invites/{inviteId}
Revoke a share link, and everybody who joined through it.
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X DELETE https://api.zinndigital.com/v1/agency/boards/{boardId}/invites/{inviteId} \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
⛔⛔ **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.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
boardId (path) | Uuid | Sim | Project board ID (UUIDv7). |
inviteId (path) | Uuid | Sim | Board share-link ID (UUIDv7). Not the token — see `BoardShareToken`. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
revoked | boolean | Sim | — |
seats_removed | integer | Sim | 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… |
Erros que este endpoint pode retornar
401 · 403 · 404