# Redeem an API key invitation

**POST /v1/api-keys/invites/{code}/redeem**


  If you have an invitation code, you can redeem it to create an Organization and an API key associated with it.
  


## Servers
- https://api.sensay.io: https://api.sensay.io ()



## Parameters
### Headers
- **X-API-Version** (string)


### Path parameters
- **code** (string)
  The code of the invite you want to redeem.


### Body: application/json (object)

- **organizationName** (string)
  The name of the organization you want to create.
- **name** (string)
  The name of the point of contact for the API subscription.
- **email** (string(email))
  The email of the point of contact for the API subscription.


## Responses
### 200
Details about the created Organization and API Key.

#### Body: application/json (object)
- **success** (boolean)

- **apiKey** (string)
  The API key you will need to use to authenticate your requests. The key cannot be retrieved again after it is created: keep it safe.
- **organizationID** (string)
  The ID of the organization you have just created. You will need this ID to communicate with our team. Keep it safe.
- **validUntil** (string | null)
  The date until which the API subscroption is valid.

### 400
Bad Request

#### Body: application/json (object)
- **success** (boolean)
  Indicates the status of the request
- **error** (string)
  A text representation of the error
- **error_code** (string)
  A machine-readable error code indicating the specific error condition. Used for programmatic error handling
- **fingerprint** (string)
  A unique identifier of the event, useful for reporting
- **request_id** (string)
  A unique identifier of the request, useful for reporting

### 401
Unauthorized

#### Body: application/json (object)
- **success** (boolean)
  Indicates the status of the request
- **error** (string)
  A text representation of the error
- **error_code** (string)
  A machine-readable error code indicating the specific error condition. Used for programmatic error handling
- **fingerprint** (string)
  A unique identifier of the event, useful for reporting
- **request_id** (string)
  A unique identifier of the request, useful for reporting

### 404
Not Found

#### Body: application/json (object)
- **success** (boolean)
  Indicates the status of the request
- **error** (string)
  A text representation of the error
- **request_id** (string)
  A unique identifier of the request, useful for reporting

### 415
Unsupported Media Type

#### Body: application/json (object)
- **success** (boolean)
  Indicates the status of the request
- **error** (string)
  A text representation of the error
- **error_code** (string)
  A machine-readable error code indicating the specific error condition. Used for programmatic error handling
- **fingerprint** (string)
  A unique identifier of the event, useful for reporting
- **request_id** (string)
  A unique identifier of the request, useful for reporting

### 500
Internal Server Error

#### Body: application/json (object)
- **success** (boolean)
  Indicates the status of the request
- **error** (string)
  A text representation of the error
- **fingerprint** (string)
  A unique identifier of the event, useful for reporting
- **request_id** (string)
  A unique identifier of the request, useful for reporting
- **inner_exception** (object)
  The inner exception


[Powered by Bump.sh](https://bump.sh)