Grant a Guest Badge
POST/guest.badge.create
Grant a Guest Badge so an email that is not a workspace member can visit a host in Roam.
This is not an On-Air event guest. It is
also not implied by group.add: adding an email
to a group does not mint a badge or send the invite. Typical onboarding is
guest.badge.create then group.add.
Repeating create for the same host and email returns the existing badge
(visitPermission is not updated) and does not re-send the invite.
Access: Organization and Personal.
Organization tokens require hostUserId. Personal tokens default to the
token owner; naming a different host returns 403 access_mode_not_supported.
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
Badge created, or the existing grant returned.
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.