Account

Invite a teammate to the workspace

Invites someone by email as an admin or a member of the active workspace. Inviting an address that already has a pending invite re-sends it and extends the expiry instead of creating a second one. Only a workspace Owner or Admin can invite. To share a single site instead, use createSiteInvite.

post/api/v1/account/workspace-invites

Request

Base URL: https://api.dotsy.ai
URL: https://api.dotsy.ai/api/v1/account/workspace-invites
Auth: HTTP bearer

Headers

X-Dotsy-Workspacestring

Org id or slug to act as for this request (session/MCP user actors only — ignored for pga_ keys). Validated against the caller's own memberships (id match first, then slug); 403 if not a member. Takes precedence over session.activeOrganizationId and the auto-provisioned home-workspace fallback.

Request body

emailstring email required

Who to invite.

role'admin' | 'member' required

admin or member. Never owner: promote someone to owner after they join.

Example request

{
  "email": "grace@example.com"
}

Response

The invitation.

idstring required

emailstring required

rolestring required

admin or member.

statusstring required

pending until the person accepts, declines or the invite expires.

expiresAtstring date-time required

When the invite stops working.

createdAtstring date-time required

When the invite was created.

organizationIdstring required

The workspace the invite is for.

acceptPathstring required

Dashboard path the invited person opens to accept.

workspaceSiteCountnumber required

How many sites a new teammate will see. Use it in a confirmation like "Add teammate: sees all N sites".

emailSentboolean required

True when an email was sent. False when email is not configured on this server, so share acceptPath yourself.

Example response

{
  "expiresAt": "2026-10-09T09:00:00.000Z",
  "createdAt": "2026-10-09T09:00:00.000Z",
  "acceptPath": "/invite/workspace/inv_abc123"
}

Changes

No recorded changes to this operation across all 1 revision of this API.