Replace the recipients of a CC list
/cc-lists/{id}/recipientsMakes the users you send the only recipients and returns them. Up to 1000 distinct ids; [] removes everyone. The same 422 rules as adding apply. Emits cc_list.updated (recipients) when it changed; no email. Sending the old ids undoes it.
Path parameters
The CC list's id. CC lists are keyed by integer ids, not UUIDs: a whole number from 1 to 2147483647.
Query parameters
Validate and run the call without committing it, returning what the real call would return with
meta.dry_runset.
Headers
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 · CcListRecipientReplace
Every user the CC list should have, at most 1000 distinct ids. Send an empty list to remove everyone. The same rules as adding apply.
{
"user_ids": [
"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"2b3c4d5e-6f70-4b8c-9dae-1f2a3b4c5d6e"
]
}Responses
{
"data": [
{
"id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
"first_name": "string",
"last_name": "string",
"email": "string"
}
]
}Authorization failed. error.code is one of org_disabled,
ip_blocked, missing_scope, scope_disabled, user_disabled.
The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per
problem, or a code documented on the operation.
Examples
curl -X PUT https://your-org-domain/kong/core/api/v2/cc-lists/{id}/recipients\
-H "Authorization: Bearer $HELM_API_KEY"\
-H "Content-Type: application/json"\
-d '{
"user_ids": [
"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"2b3c4d5e-6f70-4b8c-9dae-1f2a3b4c5d6e"
]
}'