Regenerate an API key

Requires a verified session and current workspace membership; metadata roles never authorize key access. An owner or admin may regenerate a teammate's key, but only the key's owner receives the new full value; for anyone else data.api_key is null. Refuses (400 USE_AI_CONNECTORS_SETTINGS) to regenerate an AI connector key; create a new one in Settings → AI Connectors instead.

POST

https://api.channelautomation.com/api/api-keys/{id}/regenerate

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

id
string
required

Header parameters

X-Workspace-Id
optional
string

Returns

200

Operation completed

201

Key created

400

Invalid input or workspace missing

401

Verified session required

403

Membership or key authority denied

404

Key not found

503

Authority verification unavailable

Regenerate an API key

curl --request POST \
  --url 'https://api.channelautomation.com/api/api-keys/<id>/regenerate' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const url = 'https://api.channelautomation.com/api/api-keys/<id>/regenerate';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/api-keys/<id>/regenerate"

payload = {}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)