Skip to main content
POST
cURL
Legacy endpoint. /api/v1/invitations/ predates workspaces. It keeps working for existing integrations, but it cannot place an invitee in a workspace. New integrations should use Invite User, which takes the same request with the role named organization_role and accepts workspaces.
The request takes email, role (owner, admin, or member; defaults to member), and the optional first_name, last_name, functional_area, and other_functional_area. It answers 201 for a new invitation and 200 for a resend, with the legacy invitation object. The rules, resend behavior, and errors are the same as Invite User.

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Body

email
string<email>
required
Maximum string length: 254
first_name
string
Maximum string length: 150
last_name
string
Maximum string length: 150
role
enum<string>
default:member

Defaults to member. You cannot invite somebody to a role above your own, and on the Free plan only owners can be invited.

  • owner - Owner
  • admin - Admin
  • member - Member
Available options:
owner,
admin,
member
functional_area
  • data_analytics - Data & Analytics
  • sales - Sales
  • customer_support - Customer Support
  • operations - Operations
  • marketing - Marketing
  • finance - Finance
  • product_development - Product Development
  • growth - Growth
  • executive_leadership - Executive Leadership
  • other - Other
Available options:
data_analytics,
sales,
customer_support,
operations,
marketing,
finance,
product_development,
growth,
executive_leadership,
other
other_functional_area
string | null
Maximum string length: 128

Response

201 - application/json
id
string<uuid>
required
read-only
email
string<email>
required
Maximum string length: 254
sent_at
string<date-time>
required
read-only
expires_at
string<date-time>
required
read-only
accepted_at
string<date-time> | null
required
read-only
revoked_at
string<date-time> | null
required
read-only
created_at
string<date-time>
required
read-only
created_by
object
required
first_name
string
Maximum string length: 150
last_name
string
Maximum string length: 150
role
enum<string>
default:member

Defaults to member. You cannot invite somebody to a role above your own, and on the Free plan only owners can be invited.

  • owner - Owner
  • admin - Admin
  • member - Member
Available options:
owner,
admin,
member
functional_area
  • data_analytics - Data & Analytics
  • sales - Sales
  • customer_support - Customer Support
  • operations - Operations
  • marketing - Marketing
  • finance - Finance
  • product_development - Product Development
  • growth - Growth
  • executive_leadership - Executive Leadership
  • other - Other
Available options:
data_analytics,
sales,
customer_support,
operations,
marketing,
finance,
product_development,
growth,
executive_leadership,
other
other_functional_area
string | null
Maximum string length: 128