Distribution Lists

Remove a member from a distribution list

DELETE/distribution-lists/{id}/members/{member_id}
distribution-lists:writeremove_distribution_list_memberDestructiveIdempotent

Removes the user from the list and returns 204, also when they were not a member, so a retry is safe. No dry run. Emits distribution_list.updated (members) only when someone was removed; no email. Adding the user again 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.

  • member_idstring (uuid)Required#

    The id of the user to remove.

Responses

204

The user is no longer a member.

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 DELETE https://your-org-domain/kong/core/api/v2/distribution-lists/{id}/members/{member_id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"