FlowFast API

FlowFastDevelopers

rest external webhooks webhooks scim user metadata imports addons

Invite user to space

POST

https://example.flowfast.io/api/latest/spaces/{space_id}/users

Path parameters

Name	Type	Reference
space_idrequired	integer	Space ID

Headers

Name	Value
Content-Type	application/json

Attributes

schema

{
 "$schema": "http://json-schema.org/draft-06/schema",
 "type": "object",
 "properties": {
  "email": {
   "type": "string",
   "description": "User email address"
  },
  "role_id": {
   "type": "string",
   "description": "Role id. Preset roles :\n reader - '06ccb31f-426b-4fa3-b7e5-861daee95696',\n writer - 'a431ed00-1b32-4cc7-92b6-85e4bc7de40e',\n admin - '07ea3efc-a004-4d31-8683-4bb2084e209b'"
  },
  "guest": {
   "type": "boolean",
   "description": "Set true to invite the user as a guest"
  },
  "operator_comment": {
   "type": "string",
   "description": "Operator's comment"
  },
  "send_email": {
   "type": "boolean",
   "description": "Whether to send email or not"
  }
 },
 "required": [
  "email"
 ]
}

Name	Type	Description
email required	string	User email address
role_id	string	Role id. Preset roles : reader - '06ccb31f-426b-4fa3-b7e5-861daee95696', writer - 'a431ed00-1b32-4cc7-92b6-85e4bc7de40e', admin - '07ea3efc-a004-4d31-8683-4bb2084e209b'
guest	boolean	Set true to invite the user as a guest
operator_comment	string	Operator's comment
send_email	boolean	Whether to send email or not

Responses

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
user	object Schema	User info
access_record	object Schema	Access record data
message	string	Success message

400

Description	Response type	Example
Validation error	Object	Open

Response Attributes

Name	Type	Description
message	string	Error message

401

Description	Response type	Example
Invalid token	String	Open

A schema has not been defined for this response code.

403

Description	Response type	Example
Forbidden		Response body does not exist

A schema has not been defined for this response code.

404

Description	Response type	Example
Not found		Response body does not exist

A schema has not been defined for this response code.

Examples

How to invite user as guest

{
  "email": "userEmail@google.com",
  "guest": true
}

FlowFast

If you have any questions or need help with integration feel free to write us at support@flowfast.io

Company domain

Path Parameters

space_id

Raw Body(json format)

  1  curl --request POST \
  2       --url 'https://example.flowfast.io/api/latest/spaces/{space_id}/users' \
  3       --header 'Accept: application/json' \
  4       --header 'Content-Type: application/json'
  5

Response

ClickTry It!to start a request and see the response here!