POST /collaborators

Invite collaborators to specific projects on an account

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
[] Array Yes
[].id String No

The unique identifier of the user

[].profile Object No
[].profile.email String No

User's email

[].profile.last_name String No

User's last name

[].profile.first_name String No

User's first name

[].profile.profile_image String No

User's profile image URL

[].project_roles[] Array No
[].project_roles[].project_id Integer No

The unique identifier of the Project

[].project_roles[].invitation_status String No

Valid values:

  • "pending"
[].project_roles[].role String No

Valid values:

  • "restricted_editor"
  • "editor"
  • "viewer"
  • "publisher"
  • "project_owner"
  • "administrator"
  • "restricted_publisher"

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.