Generate an API Key

Generate a new API key and corresponding Secret key for a Business Account. This is the only time the Secret key will be returned. The BA_ADMIN role is required to call this API.

Endpoint

POST /v1/accounts/{accountId}/apikeys

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

accountId REQUIRED

string

RocketCOMS Business Account ID.

Request Body

None

Returns

Returns the API key and Secret key.

string (UUID)

Unique ID used by RocketCOMS to identify the API key/secret pair.

key

string

API key.

secret

string

API secret key.

SAMPLE RESPONSE

				
					{
  "status": "0000",
  "result": {
    "id": "ba68bc22-d512-4467-8a54-e92d8e8a9c53",
    "key": "0cd7f9b65ed249c59b9bcd161016fe4b",
    "secret": "f769c48fb1b94b3cba96bc35ae255e76"
  }
}