1. OpenAPI (Demo)
  2. Members
  3. Invite an organization member
ReadmeGitHub
  • Platform API overview
  • Quickstart
  • POSTCreate a member session
  • POSTRefresh a member session
  • DELETERevoke a member session
  • GETList organizations
  • POSTCreate an organization
  • GETGet an organization
  • PATCHUpdate an organization
  • GETList organization members
  • POSTInvite an organization member
  • DELETERemove an organization member
  • PATCHUpdate a member role
  • GETList projects
  • POSTCreate a project
  • GETGet a project
  • DELETEArchive a project
  • PATCHUpdate a project
  • GETList project environments
  • POSTCreate a project environment
  • GETList project documents
  • POSTCreate a project document
  • GETGet a document
  • DELETEArchive a document
  • PATCHUpdate a document
  • POSTPublish a document
  • GETList contacts
  • POSTCreate a contact
  • GETGet a contact
  • DELETEDelete a contact
  • PATCHUpdate a contact
  • GETList product events
  • GETGet analytics overview
  • GETList workflows
  • POSTCreate a workflow
  • GETList workflow runs
  • GETList webhook subscriptions
  • POSTCreate a webhook subscription
  • GETGet a webhook subscription
  • DELETEDelete a webhook subscription
  • PATCHUpdate a webhook subscription
  • GETList webhook deliveries
  • POSTReplay a webhook delivery
  • GETList files
  • POSTCreate a multipart file upload
  • GETGet file metadata
  • DELETEDelete a file
  • GETGet current subscription
  • PATCHUpdate subscription settings
  • GETList invoices
  • GETGet metered usage
  • GETList API keys
  • POSTCreate an API key
  • POSTRevoke an API key
  • GETList audit logs
  • GETList exports
  • POSTCreate an export
  • GETGet API health
POST/organizations/{organizationId}/members

Invite an organization member

Sends an invitation with the requested workspace role and project access.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL
Bearer tokenBearerAuthoptional
Stored only in this browser for the BearerAuth security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

organizationIdpath · stringrequired

Opaque organization identifier.

Idempotency-Keyheader · string · uuidoptional

Unique key for retry-safe writes, retained for 24 hours.

Request body

application/jsonrequired
emailstring · emailrequired
roleenumrequired

Values: "owner" · "admin" · "editor" · "viewer" · "billing"

project_idsarray<string>optional
messagestringoptional

Responses

201application/json

Invitation created.

{
  "id": "mem_01J8F3D2P9Q7V6N5M4K",
  "email": "mira@northstar.example",
  "name": "Mira Kowalska",
  "role": "admin",
  "status": "active",
  "last_seen_at": "2026-09-03T12:08:41Z",
  "created_at": "2025-01-12T09:15:00Z"
}
idstringoptional
emailstring · emailoptional
namestringoptional
rolestringoptional
statusstringoptional
last_seen_atstring · date-timeoptional
created_atstring · date-timeoptional
409

Member is already active or invited.

List organization members< PreviousRemove an organization memberNext >

Powered by heyo

curl --request POST \  'https://api.demo.heyo.example/v3/organizations/org_01J8F1Q6N6VTX4E8W9R2D0A7B3/members' \  --header 'Idempotency-Key: 5ba89923-8c6d-44a3-9ab7-2fbbdb865f9a' \  --header 'Content-Type: application/json' \  --data '{  "email": "jon@northstar.example",  "role": "editor",  "project_ids": [    "prj_01J8F5KM4MAB0V7YQ6P3N2R8D1"  ],  "message": "Welcome to the launch team!"}'
{  "id": "mem_01J8F3D2P9Q7V6N5M4K",  "email": "mira@northstar.example",  "name": "Mira Kowalska",  "role": "admin",  "status": "active",  "last_seen_at": "2026-09-03T12:08:41Z",  "created_at": "2025-01-12T09:15:00Z"}