Revoke a Guest Badge
POST/guest.badge.revoke
Revoke Guest Badge(s) for an email.
If only one host in the workspace has granted this email, hostUserId may
be omitted. If several hosts have, pass hostUserId to pick which grant
to revoke (400 missing_parameter otherwise). Same-host alias rows are
all revoked together.
Returns { "revoked": true } when a matching grant was found and deleted,
or { "revoked": false } when there was nothing to revoke (already gone,
including after the host was archived — archiving a member deletes the
badges they granted). Naming an archived host does not 404.
Personal tokens can only revoke badges they issued. Naming another host is
403 access_mode_not_supported; omitting hostUserId when only another
host granted the email is a no-op (revoked: false).
Access: Organization and Personal.
Required scope: guest:write. Personal Access Tokens use the
pat:guests:write group.
See Guest Badges.
OpenAPI Spec: chat-v1.json
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 500
Revoke attempted. revoked is true only when a matching grant was deleted.
Error response. ok is always false; branch on the machine-readable error code. See the Responses and Errors guide.
Error response. ok is always false; branch on the machine-readable error code. See the Responses and Errors guide.
Error response. ok is always false; branch on the machine-readable error code. See the Responses and Errors guide.
Error response. ok is always false; branch on the machine-readable error code. See the Responses and Errors guide.
Error response. ok is always false; branch on the machine-readable error code. See the Responses and Errors guide.
Error response. ok is always false; branch on the machine-readable error code. See the Responses and Errors guide.