CC Lists

Create a CC list

POST/cc-lists
cc-lists:writecreate_cc_list

Creates a CC list and returns it with a Location. A name another live list of the organisation has, ignoring case and accents, returns 422 unique. dry_run shows the result without saving it. Emits cc_list.created; no email. DELETE /cc-lists/{id} undoes it.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · CcListCreate

  • namestringRequired#

    The name of the list. Another live list of the organisation can't have the same name, ignoring case.

{
  "name": "Family office advisers"
}

Responses

201

The CC list was created.

CcList
{
  "data": {
    "id": 1,
    "name": "string",
    "recipient_count": 1,
    "assigned_count": 1,
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/cc-lists\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "name": "Family office advisers"
}'