agency-board
DELETE /v1/agency/boards/{boardId}/invites/{inviteId}
Revoke a share link, and everybody who joined through it.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X DELETE https://api.zinndigital.com/v1/agency/boards/{boardId}/invites/{inviteId} \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
⛔⛔ **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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
boardId (path) | Uuid | Yes | Project board ID (UUIDv7). |
inviteId (path) | Uuid | Yes | Board share-link ID (UUIDv7). Not the token — see `BoardShareToken`. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
revoked | boolean | Yes | — |
seats_removed | integer | Yes | 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… |
Errors this endpoint can return
401 · 403 · 404