# Customer workspace collaborators

This API enables you to manage collaborators in a customer workspace. To work with collaborators in an admin workspace, refer to the Developer API documentation for workspace collaborators.

# Rate limits

Customer workspace collaborator resources have the following rate limit:

Type Resource Limit
AllAll Customer workspace collaborators endpoints60 requests per minute. Additionally, you can send one request per user and workspace ID every 20 minutes to the Invite collaborator to managed customer workspace endpoint.

# Quick reference

Type Resource Description
POST /api/managed_users/:id/member_invitation Invites a collaborator to a customer workspace.

# Invite a collaborator to a customer workspace

Invite a collaborator to an Embedded customer workspace. The API sends an email invitation if the email you provide doesn't belong to an existing user. Collaborators can join the workspace after they create a Workato account. You can invite a specific email and workspace combination once every twenty minutes. Alternatively, you can use the Add collaborator endpoint to add a collaborator directly.

POST /api/managed_users/:id/member_invitation

# Path parameters

Name Type Description
id string
required
The Embedded customer ID or external ID.
External IDs must be URL encoded and prefixed with an E, for example: EA2300.

# Request body

Name Type Description
name string
required
The name of the collaborator.
email string
required
The email of the collaborator.
env_roles object
conditional
Configures the collaborator's environment roles. Required if role_name is not provided.
env_roles[environment_type] string
conditional
The type of environment in the workspace where you plan to invite the collaborator. Required if role_name is not provided. Use dev for single-environment workspaces.
env_roles[name] string
conditional
The role to assign the collaborator for the specific environment. Required if role_name is not provided.
env_roles[role_type] string
optional
The type of role to assign the collaborator. Accepted values include privilege_group and environment. The default value is privilege_group.
role_name string
conditional
The role to assign the collaborator. Required if env_roles is not provided.
user_group_ids array of strings
optional
The IDs of collaborator groups to assign.

SPECIFY ROLES FOR DIFFERENT ENVIRONMENTS

You must provide either role_name or env_roles in the payload:

-role_name assigns a role in the dev environment only. -env_roles lets you specify roles for different environments.

You can't combine role_name and env_roles in the same request. If both are included, Workato assigns only the roles in env_roles and ignores role_name.

# Sample request

This example request creates an invitation for the dev environment that assigns the collaborator an Admin role.

curl -X POST 'https://www.workato.com/api/managed_users/19029/member_invitation' \
  -H 'Authorization: Bearer <api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
        "name": "Josh",
        "email": "[email protected]",
        "user_group_ids": [
          "am-WxEKCibh-dTXBtz", 
          "am-APNHJbmM-hfhTD8"
        ],
        "env_roles": [
          { 
            "environment_type": "dev", 
            "name": "Admin", 
            "role_type": "privilege_group" 
          }
        ]
      }'

# Response

{
    "result": "ok"
}


Last updated: 9/9/2025, 4:36:59 PM