---
title: "Invite a person by email, with a role"
description: "The only way to add a member. The service writes to that address with a code, and a button that opens the web where the person sees the invitation and accepts it with one click; whoever integrates accepts with POST /v1/invitations/accept, signed in with an account whose verified email is the invited one. The code is never returned by the API. An email that already has a pending invitation gets that invitation back (200) and nothing is sent: use `resend`. `delivery` says whether the email went out; when it did not, the invitation still exists and can be sent again. Invitations, like memberships, live on the live organization and govern its test twin: call this with the live organization id."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.invox.page/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Invox API › Members

`POST /v1/invitations`

The only way to add a member. The service writes to that address with a code, and a button that opens the web where the person sees the invitation and accepts it with one click; whoever integrates accepts with POST /v1/invitations/accept, signed in with an account whose verified email is the invited one. The code is never returned by the API. An email that already has a pending invitation gets that invitation back (200) and nothing is sent: use `resend`. `delivery` says whether the email went out; when it did not, the invitation still exists and can be sent again. Invitations, like memberships, live on the live organization and govern its test twin: call this with the live organization id.

## Authentication

- `bearer`, http, header `Authorization`

## Header parameters

- `Idempotency-Key` (`post-invitations.header.Idempotency-Key`; string, required) — A unique value per operation. Reuse it when retrying the same operation.
  - maxLength 255
- `X-Organization` (`post-invitations.header.X-Organization`; string, optional) — Required with a person's access token: the organization to act on. Omit it with a service-account key.
  - format `uuid`

## Request body

_Required._

- `email` (`post-invitations.email`; string, required) — The address that is invited. Only a person whose VERIFIED email is this one can accept.
  - maxLength 255
- `role` (`post-invitations.role`; string, required) — The role the person gets when they accept. Only an owner invites an owner.
  - one of `"owner"`, `"admin"`, `"operator"`, `"viewer"`

## Example request

```json
{
  "email": "ana@example.com",
  "role": "operator"
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url https://api.invox.page/v1/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: string' \
  --data '
{
  "email": "ana@example.com",
  "role": "operator"
}
'
```

### TypeScript

```typescript
const url = 'https://api.invox.page/v1/invitations';
const options = {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Idempotency-Key': 'string',
    Authorization: 'Bearer <token>'
  },
  body: JSON.stringify({email: 'ana@example.com', role: 'operator'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.invox.page/v1/invitations"

payload = {
    "email": "ana@example.com",
    "role": "operator"
}
headers = {
    "Content-Type": "application/json",
    "Idempotency-Key": "string",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

A retry, or an email that was already invited: the pending invitation as it is.

#### Example

```json
{
  "object": "invitation",
  "id": "string",
  "email": "string",
  "role": "owner",
  "status": "pending",
  "final": true,
  "expires_at": "string",
  "invited_by": "string",
  "accepted_by": "string",
  "accepted_at": "string",
  "created_at": "string",
  "updated_at": "string",
  "delivery": {
    "status": "sent",
    "reason": "string",
    "reason_meaning": "string",
    "what_next": "string"
  }
}
```

- `object` (`post-invitations.response.200.object`; string, required)
- `id` (`post-invitations.response.200.id`; string, required)
- `email` (`post-invitations.response.200.email`; string, required)
- `role` (`post-invitations.response.200.role`; string, required)
  - one of `"owner"`, `"admin"`, `"operator"`, `"viewer"`
- `status` (`post-invitations.response.200.status`; string, required) — `pending` · `accepted` · `revoked` · `expired` (its days ran out, or a newer invitation replaced it).
  - one of `"pending"`, `"accepted"`, `"revoked"`, `"expired"`
- `final` (`post-invitations.response.200.final`; boolean, required) — True when nothing more can happen to it: only a pending invitation can be accepted, resent or revoked.
- `expires_at` (`post-invitations.response.200.expires_at`; string, required)
- `invited_by` (`post-invitations.response.200.invited_by`; string, required)
- `accepted_by` (`post-invitations.response.200.accepted_by`; string | null, required)
- `accepted_at` (`post-invitations.response.200.accepted_at`; string | null, required)
- `created_at` (`post-invitations.response.200.created_at`; string, required)
- `updated_at` (`post-invitations.response.200.updated_at`; string, required)
- `delivery` (`post-invitations.response.200.delivery`; any of, required) — The email THIS call sent; `null` when it sent none (a retry, or an invitation that was already pending).
  - any of:
    - `object`
      - `status` (`post-invitations.response.200.delivery.1.status`; string, required)
        - one of `"sent"`, `"failed"`
      - `reason` (`post-invitations.response.200.delivery.1.reason`; string | null, required)
      - `reason_meaning` (`post-invitations.response.200.delivery.1.reason_meaning`; string | null, required)
      - `what_next` (`post-invitations.response.200.delivery.1.what_next`; string, required)
    - `null`

### 201

The invitation, and what happened to its email.

#### Example

```json
{
  "object": "invitation",
  "id": "string",
  "email": "string",
  "role": "owner",
  "status": "pending",
  "final": true,
  "expires_at": "string",
  "invited_by": "string",
  "accepted_by": "string",
  "accepted_at": "string",
  "created_at": "string",
  "updated_at": "string",
  "delivery": {
    "status": "sent",
    "reason": "string",
    "reason_meaning": "string",
    "what_next": "string"
  }
}
```

- `object` (`post-invitations.response.201.object`; string, required)
- `id` (`post-invitations.response.201.id`; string, required)
- `email` (`post-invitations.response.201.email`; string, required)
- `role` (`post-invitations.response.201.role`; string, required)
  - one of `"owner"`, `"admin"`, `"operator"`, `"viewer"`
- `status` (`post-invitations.response.201.status`; string, required) — `pending` · `accepted` · `revoked` · `expired` (its days ran out, or a newer invitation replaced it).
  - one of `"pending"`, `"accepted"`, `"revoked"`, `"expired"`
- `final` (`post-invitations.response.201.final`; boolean, required) — True when nothing more can happen to it: only a pending invitation can be accepted, resent or revoked.
- `expires_at` (`post-invitations.response.201.expires_at`; string, required)
- `invited_by` (`post-invitations.response.201.invited_by`; string, required)
- `accepted_by` (`post-invitations.response.201.accepted_by`; string | null, required)
- `accepted_at` (`post-invitations.response.201.accepted_at`; string | null, required)
- `created_at` (`post-invitations.response.201.created_at`; string, required)
- `updated_at` (`post-invitations.response.201.updated_at`; string, required)
- `delivery` (`post-invitations.response.201.delivery`; any of, required) — The email THIS call sent; `null` when it sent none (a retry, or an invitation that was already pending).
  - any of:
    - `object`
      - `status` (`post-invitations.response.201.delivery.1.status`; string, required)
        - one of `"sent"`, `"failed"`
      - `reason` (`post-invitations.response.201.delivery.1.reason`; string | null, required)
      - `reason_meaning` (`post-invitations.response.201.delivery.1.reason_meaning`; string | null, required)
      - `what_next` (`post-invitations.response.201.delivery.1.what_next`; string, required)
    - `null`

### 400

`organization_required`: This credential needs to say which organization it acts on · `validation_failed`: The request is not valid · `malformed_request`: The request body is not valid JSON · `idempotency_key_required`: This write needs an Idempotency-Key header · `live_organization_required`: Members are managed on the live organization

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`post-invitations.response.400.type`; string, required)
  - format `uri`
- `title` (`post-invitations.response.400.title`; string, required)
- `status` (`post-invitations.response.400.status`; integer, required)
- `code` (`post-invitations.response.400.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"organization_required"`, `"validation_failed"`, `"malformed_request"`, `"idempotency_key_required"`, `"live_organization_required"`
- `retryable` (`post-invitations.response.400.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`post-invitations.response.400.effect`; string, required) — What did NOT happen.
- `next_steps` (`post-invitations.response.400.next_steps`; array<string>, required)
- `request_id` (`post-invitations.response.400.request_id`; string, required)
- `detail` (`post-invitations.response.400.detail`; string, optional)
- `errors` (`post-invitations.response.400.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`post-invitations.response.400.errors.path`; string, required)
  - `code` (`post-invitations.response.400.errors.code`; string, required)
  - `message` (`post-invitations.response.400.errors.message`; string, required)
  - `context` (`post-invitations.response.400.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`post-invitations.response.400.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`post-invitations.response.400.third_party.source`; string, required)
  - `message` (`post-invitations.response.400.third_party.message`; string, required)
  - `code` (`post-invitations.response.400.third_party.code`; string, optional)

### 401

`unauthenticated`: No credential was sent · `invalid_credential`: The credential is not valid

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`post-invitations.response.401.type`; string, required)
  - format `uri`
- `title` (`post-invitations.response.401.title`; string, required)
- `status` (`post-invitations.response.401.status`; integer, required)
- `code` (`post-invitations.response.401.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"unauthenticated"`, `"invalid_credential"`
- `retryable` (`post-invitations.response.401.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`post-invitations.response.401.effect`; string, required) — What did NOT happen.
- `next_steps` (`post-invitations.response.401.next_steps`; array<string>, required)
- `request_id` (`post-invitations.response.401.request_id`; string, required)
- `detail` (`post-invitations.response.401.detail`; string, optional)
- `errors` (`post-invitations.response.401.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`post-invitations.response.401.errors.path`; string, required)
  - `code` (`post-invitations.response.401.errors.code`; string, required)
  - `message` (`post-invitations.response.401.errors.message`; string, required)
  - `context` (`post-invitations.response.401.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`post-invitations.response.401.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`post-invitations.response.401.third_party.source`; string, required)
  - `message` (`post-invitations.response.401.third_party.message`; string, required)
  - `code` (`post-invitations.response.401.third_party.code`; string, optional)

### 403

`missing_scope`: The credential lacks the permission this operation requires · `organization_mismatch`: The X-Organization header names another organization than the key's · `organization_archived`: The organization is archived · `scope_not_grantable`: A permission in the request cannot be granted

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`post-invitations.response.403.type`; string, required)
  - format `uri`
- `title` (`post-invitations.response.403.title`; string, required)
- `status` (`post-invitations.response.403.status`; integer, required)
- `code` (`post-invitations.response.403.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"missing_scope"`, `"organization_mismatch"`, `"organization_archived"`, `"scope_not_grantable"`
- `retryable` (`post-invitations.response.403.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`post-invitations.response.403.effect`; string, required) — What did NOT happen.
- `next_steps` (`post-invitations.response.403.next_steps`; array<string>, required)
- `request_id` (`post-invitations.response.403.request_id`; string, required)
- `detail` (`post-invitations.response.403.detail`; string, optional)
- `errors` (`post-invitations.response.403.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`post-invitations.response.403.errors.path`; string, required)
  - `code` (`post-invitations.response.403.errors.code`; string, required)
  - `message` (`post-invitations.response.403.errors.message`; string, required)
  - `context` (`post-invitations.response.403.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`post-invitations.response.403.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`post-invitations.response.403.third_party.source`; string, required)
  - `message` (`post-invitations.response.403.third_party.message`; string, required)
  - `code` (`post-invitations.response.403.third_party.code`; string, optional)

### 404

`not_found`: The resource does not exist in this organization

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`post-invitations.response.404.type`; string, required)
  - format `uri`
- `title` (`post-invitations.response.404.title`; string, required)
- `status` (`post-invitations.response.404.status`; integer, required)
- `code` (`post-invitations.response.404.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"not_found"`
- `retryable` (`post-invitations.response.404.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`post-invitations.response.404.effect`; string, required) — What did NOT happen.
- `next_steps` (`post-invitations.response.404.next_steps`; array<string>, required)
- `request_id` (`post-invitations.response.404.request_id`; string, required)
- `detail` (`post-invitations.response.404.detail`; string, optional)
- `errors` (`post-invitations.response.404.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`post-invitations.response.404.errors.path`; string, required)
  - `code` (`post-invitations.response.404.errors.code`; string, required)
  - `message` (`post-invitations.response.404.errors.message`; string, required)
  - `context` (`post-invitations.response.404.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`post-invitations.response.404.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`post-invitations.response.404.third_party.source`; string, required)
  - `message` (`post-invitations.response.404.third_party.message`; string, required)
  - `code` (`post-invitations.response.404.third_party.code`; string, optional)

### 409

`already_member`: This person is already a member of the organization

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`post-invitations.response.409.type`; string, required)
  - format `uri`
- `title` (`post-invitations.response.409.title`; string, required)
- `status` (`post-invitations.response.409.status`; integer, required)
- `code` (`post-invitations.response.409.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"already_member"`
- `retryable` (`post-invitations.response.409.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`post-invitations.response.409.effect`; string, required) — What did NOT happen.
- `next_steps` (`post-invitations.response.409.next_steps`; array<string>, required)
- `request_id` (`post-invitations.response.409.request_id`; string, required)
- `detail` (`post-invitations.response.409.detail`; string, optional)
- `errors` (`post-invitations.response.409.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`post-invitations.response.409.errors.path`; string, required)
  - `code` (`post-invitations.response.409.errors.code`; string, required)
  - `message` (`post-invitations.response.409.errors.message`; string, required)
  - `context` (`post-invitations.response.409.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`post-invitations.response.409.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`post-invitations.response.409.third_party.source`; string, required)
  - `message` (`post-invitations.response.409.third_party.message`; string, required)
  - `code` (`post-invitations.response.409.third_party.code`; string, optional)

### 422

`idempotency_key_reused`: This Idempotency-Key was already used with a different request

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`post-invitations.response.422.type`; string, required)
  - format `uri`
- `title` (`post-invitations.response.422.title`; string, required)
- `status` (`post-invitations.response.422.status`; integer, required)
- `code` (`post-invitations.response.422.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"idempotency_key_reused"`
- `retryable` (`post-invitations.response.422.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`post-invitations.response.422.effect`; string, required) — What did NOT happen.
- `next_steps` (`post-invitations.response.422.next_steps`; array<string>, required)
- `request_id` (`post-invitations.response.422.request_id`; string, required)
- `detail` (`post-invitations.response.422.detail`; string, optional)
- `errors` (`post-invitations.response.422.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`post-invitations.response.422.errors.path`; string, required)
  - `code` (`post-invitations.response.422.errors.code`; string, required)
  - `message` (`post-invitations.response.422.errors.message`; string, required)
  - `context` (`post-invitations.response.422.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`post-invitations.response.422.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`post-invitations.response.422.third_party.source`; string, required)
  - `message` (`post-invitations.response.422.third_party.message`; string, required)
  - `code` (`post-invitations.response.422.third_party.code`; string, optional)

### 429

`rate_limited`: Too many requests

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`post-invitations.response.429.type`; string, required)
  - format `uri`
- `title` (`post-invitations.response.429.title`; string, required)
- `status` (`post-invitations.response.429.status`; integer, required)
- `code` (`post-invitations.response.429.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"rate_limited"`
- `retryable` (`post-invitations.response.429.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`post-invitations.response.429.effect`; string, required) — What did NOT happen.
- `next_steps` (`post-invitations.response.429.next_steps`; array<string>, required)
- `request_id` (`post-invitations.response.429.request_id`; string, required)
- `detail` (`post-invitations.response.429.detail`; string, optional)
- `errors` (`post-invitations.response.429.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`post-invitations.response.429.errors.path`; string, required)
  - `code` (`post-invitations.response.429.errors.code`; string, required)
  - `message` (`post-invitations.response.429.errors.message`; string, required)
  - `context` (`post-invitations.response.429.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`post-invitations.response.429.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`post-invitations.response.429.third_party.source`; string, required)
  - `message` (`post-invitations.response.429.third_party.message`; string, required)
  - `code` (`post-invitations.response.429.third_party.code`; string, optional)

### 500

`internal_error`: The service failed

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`post-invitations.response.500.type`; string, required)
  - format `uri`
- `title` (`post-invitations.response.500.title`; string, required)
- `status` (`post-invitations.response.500.status`; integer, required)
- `code` (`post-invitations.response.500.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"internal_error"`
- `retryable` (`post-invitations.response.500.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`post-invitations.response.500.effect`; string, required) — What did NOT happen.
- `next_steps` (`post-invitations.response.500.next_steps`; array<string>, required)
- `request_id` (`post-invitations.response.500.request_id`; string, required)
- `detail` (`post-invitations.response.500.detail`; string, optional)
- `errors` (`post-invitations.response.500.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`post-invitations.response.500.errors.path`; string, required)
  - `code` (`post-invitations.response.500.errors.code`; string, required)
  - `message` (`post-invitations.response.500.errors.message`; string, required)
  - `context` (`post-invitations.response.500.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`post-invitations.response.500.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`post-invitations.response.500.third_party.source`; string, required)
  - `message` (`post-invitations.response.500.third_party.message`; string, required)
  - `code` (`post-invitations.response.500.third_party.code`; string, optional)

### 503

`service_unavailable`: The service cannot answer right now

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`post-invitations.response.503.type`; string, required)
  - format `uri`
- `title` (`post-invitations.response.503.title`; string, required)
- `status` (`post-invitations.response.503.status`; integer, required)
- `code` (`post-invitations.response.503.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"service_unavailable"`
- `retryable` (`post-invitations.response.503.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`post-invitations.response.503.effect`; string, required) — What did NOT happen.
- `next_steps` (`post-invitations.response.503.next_steps`; array<string>, required)
- `request_id` (`post-invitations.response.503.request_id`; string, required)
- `detail` (`post-invitations.response.503.detail`; string, optional)
- `errors` (`post-invitations.response.503.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`post-invitations.response.503.errors.path`; string, required)
  - `code` (`post-invitations.response.503.errors.code`; string, required)
  - `message` (`post-invitations.response.503.errors.message`; string, required)
  - `context` (`post-invitations.response.503.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`post-invitations.response.503.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`post-invitations.response.503.third_party.source`; string, required)
  - `message` (`post-invitations.response.503.third_party.message`; string, required)
  - `code` (`post-invitations.response.503.third_party.code`; string, optional)


Source: https://docs.invox.page/api/post-invitations/index.md
