Create organization invitation
POST
/v1/organizations/{organizationId}/invitationsInvite a person to an organization. Requires owner or admin role.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| organizationId | path | string | Yes | Organization ID |
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| string | Yes | — | |
| role | owner | admin | billing | developer | member | viewer | No | — |
| metadata | object | No | Free-form metadata object. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
201Created organization invitationapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| data | object | No | — |
| data.id | string | No | Unique identifier. |
| data.organizationId | string | No | — |
| data.organizationName | string | No | — |
| data.email | string | No | — |
| data.emailNormalized | string | No | — |
| data.role | owner | admin | billing | developer | member | viewer | No | — |
| data.status | pending | accepted | declined | revoked | expired | No | Current lifecycle status. |
| data.invitedByUserId | string | No | — |
| data.invitedByEmail | string | No | — |
| data.invitedByName | string | No | — |
| data.acceptedByUserId | string | No | — |
| data.expiresAt | string | No | — |
| data.metadata | object | No | Free-form metadata object. |
| data.createdAt | string | No | ISO 8601 timestamp. |
| data.updatedAt | string | No | ISO 8601 timestamp. |