POST /public/v1/users

Create users, and assign them roles, licenses, and workspaces.

Servers

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 Object Yes

User info

user.email String No
user.last_name String No
user.first_name String No
user.phone_number String No
workspaces[] Array Yes

Info for adding a user to a workspace(s)

workspaces[].role String No

Role for a member.

Valid values:

  • "Collaborator"
  • "Admin"
  • "Member"
  • "Manager"
workspaces[].workspace_id String No
license String Yes

Valid values:

  • "Guest"
  • "Read-only"
  • "eSign"
  • "Full"
  • "Creator"

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.