CommunityCreate AccountSign in
  • Overview
    • Welcome
    • Authentication
    • Using Environments
  • API Reference
LogoLogo
LogoLogo
CommunityCreate AccountSign in
API ReferenceGuests

Delete a guest

DELETE
https://api.x.flatfile.com/v1/guests/:guestId
DELETE
/v1/guests/:guestId
1curl -X DELETE https://api.x.flatfile.com/v1/guests/us_g_YOUR_ID \
2     -H "X-Disable-Hooks: true" \
3     -H "Authorization: Bearer <token>"
Try it
200Example0
1{
2  "data": {
3    "success": true
4  }
5}
Deletes a single guest or removes guest access from a specific space
Was this page helpful?
Previous

Update a guest

Next
Built with
Update a guest
Deletes a single guest or removes guest access from a specific space

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Path parameters

guestIdstringRequired
ID of guest to return

Headers

X-Disable-Hooks"true"RequiredDefaults to true

Query parameters

spaceIdstringOptional
ID of space to remove guest access from. If not provided, guest will be completely deleted.
ID of space to remove guest access from. If not provided, guest will be completely deleted.

Response

This endpoint returns an object.
dataobject or null
ID of guest to return

Bearer authentication of the form Bearer <token>, where token is your auth token.