Search...
/
Community
Create Account
Sign in
Overview
Welcome
Authentication
Using Environments
API Reference
Accounts
Actions
Agents
Apps
Assistant
Commits
Data Retention Policies
Documents
Entitlements
Environments
Events
Files
Guests
GET
List guests
POST
Create a guest
GET
Get a guest
DEL
Delete a guest
PATCH
Update a guest
GET
Get guest token
GET
List Guest Roles
POST
Assign Role to Guest
DEL
Remove Role from Guest
POST
Invite guests
Jobs
Mapping
Records
Roles
Secrets
Sheets
Snapshots
Spaces
Users
Versions
Views
Workbooks
Community
Create Account
Sign in
API Reference
Guests
Assign Role to Guest
POST
https://api.x.flatfile.com/v1
/
guests
/
:guestId
/
roles
Assigns a role to a guest.
Path parameters
guestId
string
Required
The guest id
Headers
X-Disable-Hooks
"true"
Required
Defaults to
true
Request
This endpoint expects an object.
roleId
string
Required
Role ID
resourceId
string
Required
Show 3 variants
Response
This endpoint returns an object.
data
object
Show 6 properties
Errors
400
Bad Request
403
Forbidden
404
Not Found
Built with