Create Invite

Invite a new member to the workspace by email.

Reuses the same invite creation and email-send flow as the in-product "Invite" action. role is optional and defaults to the workspace's configured default role.

Returns 409 if the email is already a member of the workspace or already has a pending invite.

Returns 403 if role is organization_admin and the caller doesn't already hold organization-admin access on this workspace - only an existing organization admin can invite another one. On a free-tier workspace, role must be admin; any other role returns 400.

Returns 403 if the workspace is on a self-service plan and this invite would exceed its seat limit, its billing subscription isn't set up yet, or its subscription status doesn't currently allow billing changes (e.g. past due).

Returns 400 if the workspace's SSO provider restricts allowed email domains and email's domain isn't one of them.

post

/workspaces/{workspace_id}/invites

Authorizations

AuthorizationstringRequired

A Personal Access Token (PAT).

Path parameters

workspace_idstringRequired

Body

emailstringRequired

rolestring · enum · nullableOptional

The role to grant once the invite is accepted; defaults to the workspace's configured default role if omitted.

Possible values:

Responses

201

Successful Response

application/json

4XX

Client Error

application/json

5XX

Server Error

application/json

post/workspaces/{workspace_id}/invites

curl -L -X POST https://api-external.zenlytic.com/api/v2/workspaces/<workspace_id>/invites \
  -H 'Authorization: Bearer YOUR_TOKEN'

{
  "data": {
    "id": "invite_123",
    "workspace_id": "ws_456",
    "email": "[e-mail]",
    "role": "explore",
    "invite_url": "https://app.zenlytic.com/join-workspace/invite_123?shopName=acme",
    "created_date": "2026-01-01T00:00:00Z"
  },
  "meta": {
    "status": "success",
    "errors": [],
    "warnings": []
  }
}