POST /users

Adds a new user to the company, returns the ID upon success.

Servers

Request headers

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

Default value: "application/json"

Request body fields

Name Type Required Description
email String Yes

The email of the user

active_flag Boolean No

Whether the user is active or not. false = Not activated, true = Activated

Default value: true

access[] Array No

The access given to the user. Each item in the array represents access to a specific app. Optionally may include either admin flag or permission set ID to specify which access to give within the app. If both are omitted, the default access for the corresponding app will be used. It requires structure as follows: [{ app: 'sales', permission_set_id: '62cc4d7f-4038-4352-abf3-a8c1c822b631' }, { app: 'global', admin: true }, { app: 'account_settings' }]

Default value: [ { "app": "sales" } ]

access[].admin Boolean No
access[].permission_set_id String No
access[].app String Yes

Possible values:

  • "global"
  • "sales"
  • "partnership"
  • "account_settings"
  • "projects"
  • "campaigns"

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.