Guests

Invite guests

POST
Guests can be created as a named guest on the Space or there’s a global link that will let anonymous guests into the space.

Request

This endpoint expects a list of objects.
guestId
stringRequired
Guest ID
spaceId
stringRequired
Space ID
fromName
stringOptional
The name of the person or company sending the invitation
message
stringOptional
Message to send with the invite

Response

This endpoint returns an object
data
objectOptional
POST
$curl -X POST https://api.x.flatfile.com/v1/invitations \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '[
>  {
>    "guestId": "us_g_YOUR_ID",
>    "spaceId": "us_sp_YOUR_ID",
>    "fromName": "Your Name",
>    "message": "Hello, I would like to invite you to my space."
>  }
>]'
Response
1{
2  "data": {
3    "success": true
4  }
5}
Built with