Skip to content
Connect an agent

Organisations

Revoke an invite link

Stops an invite link working at once.

DELETE/orgs/{org}/boards/{board}/join-links/{id}

TL;DR

QuestionAnswer
What does it do?Revoke an invite link.
What does it take?org, board, id in the path.
What does it return?Status 204 with no body.
What can go wrong?401 not signed in; 403 boards are not turned on for this organisation (boards.not_enabled), the caller may look but not change it (boards.forbidden), or the request came from an origin that may not make changes; 404 no such organisation, board or tab, or the board is not open to the caller: the cases look alike; 429 too many requests; 503 organisations or boards are not set up on this server. Every failure uses the one error envelope.

What it does

Stops an invite link working at once. The people who joined with it keep their access. The people who manage the board may. Audited as orgs.board.join_link.

Path parameters

FieldTypeRequiredDescription
orgstringyesThe organisation's id or its slug.
boardstringyesThe board's id: 22 letters and digits.
idstringyes

Responses

StatusMeaningBody
204Revoked.none
401Not signed in.ErrorResponse
403Boards are not turned on for this organisation (boards.not_enabled), the caller may look but not change it (boards.forbidden), or the request came from an origin that may not make changes.ErrorResponse
404No such organisation, board or tab, or the board is not open to the caller: the cases look alike.ErrorResponse
429Too many requests.ErrorResponse
503Organisations or boards are not set up on this server.ErrorResponse

See also

DocWhy
API referenceEvery endpoint, and the error envelope
SchemasEvery request and response type
Tool referenceThe operations as callable tools