Embedded APIResourcesCustomer workspace collaborators

Invite collaborator to managed customer workspace

Invites a collaborator to a managed customer workspace. An email invite is sent if the provided email is not associated with an existing collaborator. Invited collaborators can join the workspace after they create a Workato account.

You must provide either role_name or env_roles in the payload. role_name only assigns a role in the dev environment. Use env_roles to specify the environment type and role for other environments.

Workato does not support a mixed approach to assigning roles. This means that when you combine the env_roles and role_name in the payload, Workato ignores the role_name and only assigns the roles specified by the env_roles object.

Path parameters

managed_user_idstringRequired

Embedded customer ID (external ID). The External ID must be URL encoded and prefixed with an E. For example, EA2300.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired
The name of the collaborator.
emailstringRequired
The email of the collaborator.
role_namestringOptional
The role to assign the collaborator.
env_roleslist of stringsOptional
Environment roles.

Response

Success reply
result"ok"

Errors