Create integration API key

Legacy category: This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community.

What it is for: Create integration API key.

How to use it: Send a POST request to /apis/v1/communities/6502c9e514a3e564c5c09c0a/api-keys with the documented body, query parameters, headers, or multipart fields. Prefer the newer authenticated /v1/... integration API where available.

Successful response: HTTP 2xx. Older endpoints may return a legacy response envelope or a resource-specific payload rather than the newer { status, message, data } wrapper.

Common error states:

400 invalid request body, query, ObjectId, pagination, file format, or missing required field.

401 missing, invalid, expired, or insufficient API key/token.

403 key is valid but cannot access this community/channel/user/resource, where supported by the service.

404 route or target resource was not found. Several legacy root routes returned 404 on https://api.returning.ai during smoke testing and need backend confirmation before external use.

409 duplicate or conflicting state for create/update operations, where applicable.

500 unexpected Returning.AI service error.

Legacy status:
Compatibility endpoint retained for older integrations. Do not use this endpoint for new integrations unless Returning.AI specifically tells you to maintain a legacy flow. Prefer the current /v1/... endpoint in the matching non-Legacy category when one exists.

curl --location 'https://api.returning.ai/apis/v1/communities/6502c9e514a3e564c5c09c0a/api-keys' \ --header 'Content-Type: application/json' \ --data '{ "name": "Test Integration Key14", "permissions": [ "sendMessage", "replyMessage", "getMessages", "createUser", "getUserData", "deleteRestoreUser", "getUserStats", "bulkUpdateUser", "userFields", "getTierInfos", "getBulkUpdateHistory" ], "expirePeriod": 30 }'

Request

Responses