Invite a collaborator
Invite a collaborator to your workspace. If the email you provide doesn't belong to an existing user, the API sends an email invitation. Collaborators can join your workspace after they create a Workato account. You can invite a specific email and workspace combination once every twenty minutes.
Your API client role must be assigned the Invite `POST /api/member_invitations` privilege to use this endpoint.
<Warning title="EARLY ACCESS FEATURE"> The `env_roles[role_type]` and `user_group_ids` parameters are part of the access control limited preview. The access control model is under active development and may change. Contact your Customer Success Manager to participate in early access testing.</Warning>
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
name
The name of the collaborator.
email
The email of the collaborator.
role_name
This field is deprecated. Use env_roles instead, even for single-environment workspaces.
env_roles
Defines the collaborator's environment roles.
env_roles[environment_type]
The type of environment in the workspace where you plan to invite the collaborator. Use dev for single-environment workspaces.
env_roles[role_type]
The type of role to assign the collaborator. Accepted values include privilege_group and environment. The default value is privilege_group.
user_group_ids
The IDs of collaborator groups to invite the collaborator to.
Response
Success reply
result