Distribution Lists

Update a distribution list

PATCH/distribution-lists/{id}
distribution-lists:writeupdate_distribution_listIdempotent

Changes the title or description and returns the list; send only what changes. dry_run shows the result without saving it. Emits distribution_list.updated; no email. Sending the previous values undoes it.

Path parameters

  • idintegerRequired#

    The distribution list's id. Distribution lists are keyed by integer ids, not UUIDs: a whole number from 1 to 2147483647.

Query parameters

  • dry_runboolean#

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

Request body

application/json, required · DistributionListUpdate

  • titlestring#

    The new name of the list.

  • descriptionstring | null#

    The new description, or null to clear it.

{
  "title": "Professional Investors (UK)"
}

Responses

200

The updated distribution list.

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
404

Resource not found (error.code = not_found).

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 PATCH https://your-org-domain/kong/core/api/v2/distribution-lists/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "title": "Professional Investors (UK)"
}'