Update a Guest Badge
POST/guest.badge.update
Update visitPermission on an existing Guest Badge.
guest.badge.create is idempotent and
does not change visitPermission on an existing grant. Use this
endpoint to flip on-map visit access after create.
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 update (400 missing_parameter otherwise). Same-host alias
rows are updated together.
Personal tokens can only update badges they issued. Naming another host
is 403 access_mode_not_supported; omitting hostUserId when the
token owner has no matching grant is 404 not_found.
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
The updated Guest Badge.
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.