Sign in
API Keys

Redeem an API key invitation

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

post/v1/api-keys/invites/{code}/redeem

Request

  • Base URL: https://api.sensay.io
  • URL: https://api.sensay.io/v1/api-keys/invites/{code}/redeem
  • Auth: none declared

Path parameters

codestring required

The code of the invite you want to redeem.

Headers

X-API-Versionstring
Example:2025-03-25
Content-Encoding'gzip'

Content encoding for request body compression. Optional - when used, client is responsible for gzipping and sending binary data.

Request body

organizationNamestring required

The name of the organization you want to create.

namestring required

The name of the point of contact for the API subscription.

emailstring email required

The email of the point of contact for the API subscription.

Response

Details about the created Organization and API Key.

successtrue required
apiKeystring required

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.

organizationIDstring required

The ID of the organization you have just created. You will need this ID to communicate with our team. Keep it safe.

validUntilstring nullable required

The date until which the API subscroption is valid.

Example response

{
  "success": true,
  "apiKey": "1234567890",
  "organizationID": "1234567890",
  "validUntil": "2021-01-01"
}

Changes

No recorded changes to this operation across all 1 revision of this API.