Skip to main content
POST
/
party-invitations
Invite party members
curl --request POST \
  --url https://api.natural.co/party-invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "attributes": {
      "invitations": [
        {
          "email": "engineer@velocitylogistics.com",
          "role": "MEMBER"
        },
        {
          "email": "cfo@velocitylogistics.com",
          "role": "ADMIN"
        }
      ],
      "expires_in_days": 7
    }
  }
}
'
{
  "data": [
    {
      "type": "invitation",
      "id": "inv_019cd4a832f37c4b8a1d63e94b7c8d12",
      "attributes": {
        "email": "engineer@velocitylogistics.com",
        "role": "MEMBER",
        "status": "PENDING",
        "expires_at": "2026-01-11T15:30:00Z",
        "created_at": "2026-01-04T15:30:00Z",
        "accepted_at": null
      }
    }
  ],
  "meta": {
    "failed": []
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Agent-ID
string | null

Agent ID (agt_xxx) identifying which agent is making the request.

X-Instance-ID
string | null

Agent session/conversation ID for observability.

Maximum string length: 1024

Body

application/json

Request to create party invitations: {data: {attributes: ...}}.

data
InvitationCreateData · object
required

Resource object

Response

Successful Response

JSON:API response for batch invitation creation.

Successful invitations are returned as resources in data[]. Failed attempts are in meta.failed.

data
InvitationResource · object[]
required

Successfully created invitation resources

meta
CreateInvitationsMeta · object
required

Metadata including failed attempts