Create a distribution list

POST/distribution-lists

distribution-lists:write create_distribution_list

Creates a distribution list in the organisation, credits the calling user as its creator and returns it with a Location. dry_run shows the result without saving it. Emits distribution_list.created; no email. DELETE /distribution-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 · DistributionListCreate

titlestringRequired#
The name of the list.
descriptionstring | null#
What the list is for, in free text.

{
  "title": "UK Professional Investors",
  "description": "Investors classified as professional in the UK."
}

Responses

201

The distribution list was created.

DistributionList

{
  "data": {
    "id": 1,
    "title": "string",
    "description": "string",
    "member_count": 1,
    "created_by": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "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/distribution-lists\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "title": "UK Professional Investors",
  "description": "Investors classified as professional in the UK."
}'