API Keysv4

Create an API key

POST/api-keys

Mints a new API key for the installed organization and returns it. This is the only way to create an API key programmatically — the raw key is returned once in this response; store it securely.

A new key owns no numbers until you assign channels to it (see Assign a channel to an API key) and, by default, has no explicit expiry (valid_until: -1). Organizations are capped at a fixed number of active keys; exceeding it returns 409 api_key_limit_reached.

Blooio Apps (OAuth) only. Requires the apikeys:manage scope. API-key and dashboard authentication are rejected with 403 oauth_token_required.

Headers

AuthorizationRequiredstring

Your API key, sent as a bearer token: Authorization: Bearer <api_key>. Editing this stays in sync with the API key box on the right.

Bearer

Body parameters

JSON

nameoptionalstring

Human-readable label for the key.

typeoptionalstring

Optional key type/category tag.

valid_untiloptionalinteger | null

Expiry time (epoch milliseconds). Pass null or -1 (or omit) for a key that never expires.

Returns

dataoptionalApiKey

An organization API key. The api_key field is the secret bearer value — it is returned in full by the create and list endpoints and must be stored securely.

api_keyoptionalstring

The secret key value (prefixed api_). Send it as Authorization: Bearer <api_key> on API requests.

nameoptionalstring | null

Human-readable label for the key.

typeoptionalstring | null

Optional key type/category tag.

created_atoptionalinteger | null

Creation time (epoch milliseconds).

valid_untiloptionalinteger

Expiry time (epoch milliseconds), or -1 when the key never expires.

blockedoptionalboolean

Whether the key is blocked (suspended).

deprecatedoptionalboolean

Whether the key has been deprecated (revoked).

Response codes

201The created API key. The `api_key` value is shown only in this response.

401Your API key is missing or invalid. Pass it as a bearer token.

403Your API key isn't allowed to access this api key (blocked key or plan limit).

409The request conflicts with the current state of the api key (e.g. it already exists, the chat is closed, or the channel isn't active).

Sends a live request with your values and shows the real response below. Your key is stored only in this browser.

Request

curl -X POST https://api.blooio.com/v4/api-keys \

  -H "Authorization: Bearer bl_live_..." \  -H "Content-Type: application/json" \  -d '{    "name": "Jane Doe",    "type": "string",    "valid_until": 0  }'

Body object

{  "name": "Jane Doe",  "type": "string",  "valid_until": 0}

Response objectexample

{  "data": {    "api_key": "sk_live_a1b2c3d4",    "name": "Jane Doe",    "type": "string",    "created_at": 0,    "valid_until": 0,    "blocked": false,    "deprecated": false  }}