POST /public/v1/workspaces/{workspace_id}/members

Add an existing user to a workspace.

Servers

Path parameters

Name Type Required Description
workspace_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
notify_user Boolean No

Send a confirmation email to the user that was added to workspace(s).

notify_ws_admins Boolean No

Send a confirmation email to all workspace admins indicating that the user has been added to the workspace.

Request body fields

Name Type Required Description
user_id String Yes

User id.

role String Yes

Role for a member.

Valid values:

  • "Collaborator"
  • "Admin"
  • "Member"
  • "Manager"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.