Invite Members

Invite one or more team members by email. Assign either a role_id from member roles or a preset key returned by the member permissions endpoint. Invitations are scoped to the authenticated organization.

Authorization

BearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Request payload.

TypeScript Definitions

Use the request body type in TypeScript.

emails?array<>

Email addresses to invite into the organization as team members.

Items1 <= items <= 50

role_id*string

Public role reference from the member roles endpoint. Required when preset is not supplied.

Formatuuid

preset?string

Preset key from the member permissions endpoint. Required when role_id is not supplied.

expires_in_days?integer

Number of days before the invitation expires.

Range1 <= value <= 90

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/members/invite" \  -H "Content-Type: application/json" \  -d '{    "members": [      {        "first_name": "Eli",        "last_name": "Brooks",        "email": "eli.brooks@northstar-distribution.co.uk",        "role_id": "c0f1c68c-7c2f-4954-b52c-9d7e5eb46d3e"      }    ],    "message": "Please join Northstar Distribution to manage catalog operations."  }'

{  "success": true,  "message": "Member invitations sent.",  "data": {    "members": [      {        "member_id": "54dbefc4-49b2-4b18-9945-0921fd07a9fd",        "first_name": "Eli",        "last_name": "Brooks",        "name": "Eli Brooks",        "email": "eli.brooks@northstar-distribution.co.uk",        "status": "active",        "role": {          "role_id": "c0f1c68c-7c2f-4954-b52c-9d7e5eb46d3e",          "name": "Catalog Manager"        },        "permissions": [          "view releases",          "create releases",          "update releases"        ],        "is_suspended": false,        "invited_at": "2026-07-01T12:00:00+00:00",        "accepted_at": "2026-07-02T09:05:00+00:00"      }    ],    "invitations": [      {        "invitation_id": "9406c9cf-4880-43e6-a6db-59cc8c71502f",        "email": "catalog.ops@northstar-distribution.co.uk",        "role": {          "role_id": "c0f1c68c-7c2f-4954-b52c-9d7e5eb46d3e",          "name": "Catalog Manager"        },        "status": "pending",        "sent_at": "2026-07-04T09:30:00+00:00",        "expires_at": "2026-07-11T09:30:00+00:00"      }    ]  }}

Authorization

Request Body

Response Body

201application/json

401application/json

403application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`