POST /roles/{roleId}/members

User roles can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to assign a role to members.

Scopes: role:write:admin

Rate Limit Label: Medium
Prerequisites:

Servers

Path parameters

Name Type Required Description
roleId String Yes

The role ID

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
members[] Array No

Array of userId/user email of users to whom you would like to assign this role. Upto 30 users can be assigned a role at once.

members[].id String No

User ID of the user to whom you would like to assign the role.

members[].email String No

Email address of the user to whom you would like to assign the role. Provide either the userId in the ID field or the email address in the email field. If both fields are provided, only userId is used.

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.