# redeemInvitation

Source: /openapi/thomas-federated.openapi.json

## Operation

| Method | URL |
|---|---|
| POST | https://dev-cxi-api.thomas.co/v1/invitations/redeem |

| Field | Value |
|---|---|
| operationId | redeemInvitation |
| method | POST |
| server | https://dev-cxi-api.thomas.co/v1 |
| path | /invitations/redeem |
| tags | `Invitations` |
| summary | Redeem invitation |
| badges | None |

## Request Parameters

None.

## Request Body

| Content type | Schema refs |
|---|---|
| application/json | #/components/schemas/RedeemInvitationRequestDto |

## Responses

| Status | Description | Schema refs |
|---|---|---|
| 200 | Invitation redeemed successfully | #/components/schemas/RedeemInvitationResponseDto |
| 400 | Invalid invitation token (IDENTITY_INVITATION_INVALID) | #/components/schemas/ApiErrorResponseDto |
| 404 | Invitation not found (IDENTITY_INVITATION_NOT_FOUND) | #/components/schemas/ApiErrorResponseDto |
| 410 | Invitation has expired (IDENTITY_INVITATION_EXPIRED) | #/components/schemas/ApiErrorResponseDto |
| 429 | Rate limit exceeded. | #/components/schemas/ApiErrorResponseDto |

### Response 429 headers

| Name | Description | Schema |
|---|---|---|
| Retry-After | Seconds until the rate-limit block expires before retrying. | {"type":"integer","minimum":0} |
| RateLimit-Limit | Configured request limit for the active rate-limit window. | {"type":"integer"} |
| RateLimit-Remaining | Requests remaining in the active rate-limit window; zero when blocked. | {"type":"integer"} |
| RateLimit-Reset | Seconds until the rate-limit block expires. | {"type":"integer","minimum":0} |

## Artifact Examples

### Response 400 example

```json
{
  "statusCode": 400,
  "message": "Invalid invitation token",
  "error": "IDENTITY_INVITATION_INVALID"
}
```

### Response 404 example

```json
{
  "statusCode": 404,
  "message": "Invitation not found",
  "error": "IDENTITY_INVITATION_NOT_FOUND"
}
```

### Response 410 example

```json
{
  "statusCode": 410,
  "message": "Invitation has expired",
  "error": "IDENTITY_INVITATION_EXPIRED"
}
```

### Response 429 example

```json
{
  "statusCode": 429,
  "message": "ThrottlerException: Too Many Requests",
  "error": "HTTP_TOO_MANY_REQUESTS"
}
```