Create API key

POST /app/api-keys

Creates a new API key for the authenticated user and returns the full secret once. The secret cannot be retrieved again after this response — store it securely immediately.

The number of API keys per user is limited by your plan quota. Creating a key when the limit is reached returns 409.

Requires the API Access plan feature. Available to all authenticated users (admin and user roles).

Request

See API Basics for required headers.

Request body

Sample request

curl -X POST https://api.recomly.com/app/api-keys \
  -H "Authorization: Bearer rk_live_abc123:def456" \
  -H "Content-Type: application/json" \
  -d '{"name": "Zapier integration"}'

Sample response

Status: 200 OK

{
  "key": "rk_live_abc123:s3cr3tDef456plaintext",
  "keyId": "rk_live_abc123",
  "name": "Zapier integration",
  "createdAt": "2026-04-15T12:00:00.000Z"
}

The key field is the full keyId:secret string to use in the Authorization header. It is returned only once and cannot be recovered. Revoke and recreate the key if lost.

Error responses

See API Basics for standard status codes and error response format.