Skip to main content
POST
Invite team member

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Body

application/json
email
string<email>
required

Email address of the person to invite.

name
string

Optional display name for the member.

role
enum<string>
default:member

Membership role. Use ownership transfer to appoint an owner.

Available options:
admin,
member,
viewer,
billing

Response

Member added and invitation email attempted. If invite_email_error is present, the membership is saved; use the application to resend the login link.

data
object
required