agency-board

DELETE `/v1/agency/boards/{boardId}/invites/{inviteId}`

Revoke a share link, and everybody who joined through it.

Аутентификация

Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X DELETE https://api.zinndigital.com/v1/agency/boards/{boardId}/invites/{inviteId} \
  -H "Authorization: Bearer zdk_live_…"

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

⛔⛔ **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.

Параметры

Имя	Тип	Обязательно	Что это
`boardId (path)`	`Uuid`	Да	Project board ID (UUIDv7).
`inviteId (path)`	`Uuid`	Да	Board share-link ID (UUIDv7). Not the token — see `BoardShareToken`.

Ответ

Имя	Тип	Обязательно	Что это
`revoked`	`boolean`	Да	—
`seats_removed`	`integer`	Да	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…

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404

DELETE /v1/agency/boards/{boardId}/invites/{inviteId}