Add recipients to a CC list
/cc-lists/{id}/recipientsAdds up to 1000 users to the list and returns every recipient. Users must belong to your own organisation, not be suspended or deleted and not be service accounts, else 422 exists naming the user_ids entry, and none is added. Existing recipients are skipped. Emits cc_list.updated (recipients) when it changed; no email. DELETE on the recipient 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 · CcListRecipientInput
The users to add, at most 1000 distinct ids. Each must be an active user of your own organisation and not a service account. Users already on the list are skipped.
{
"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 POST 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"
]
}'