Skip to main content
POST
Invite a workspace member
string
required
The API key for your account. You can find this in your account settings.
Requires an API key with the workspaces:manage scope. Adds a member to a workspace using a short-lived code from Get Invite Code: the invited user is identified by the code, and the caller assigns their role with group. Only the workspace owner can call this endpoint, and the workspace’s member count is capped by the owner’s plan tier. The role in group decides what the member can do on the workspace’s shared applications: see Roles. Change a role later with Change Permissions. An owner cannot invite themselves. Rate limited to 1 addition every 5 seconds per user.

Roles

The dashboard shows each role by name, and the API takes the value in the group column. The workspace owner shows up in member lists with group: "owner" and always has full access. owner can’t be assigned.

Parameters

string
required
The ID of the workspace.
string
required
A string with the member invite code.
string
required
The member’s role: view, manager, maintain or admin. See Roles.

Response

string
Indicates whether the call was successful: success if it was, error if not.

Common errors