Skip to main content

Documentation Index

Fetch the complete documentation index at: https://koreai.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Back to API List

​
Update Contact List by ID-v2

Use this API to update a specific contact list associated with a campaign.
MethodPUT
Endpointhttps://{{host}}/campaign/api/v2/public/{{streamId}}/campaign/contactList/{{contactList}}?accountId={{accountId}}
Content-Typeapplication/json
Authorizationauth: {{JWT}} See How to generate the JWT Token.
API ScopeCampaign Management

​
Path Parameters

ParameterDescriptionType
hostEnvironment URL, for example, https://platform.kore.aistring, required
streamIdBot ID or Stream ID. You can get it from the general settings page.string, required
contactListIdUnique identifier of the contact list.string, required

​
Sample Request

curl --location --request PUT 'https://{{host}}/campaign/api/v2/public/{{streamId}}/campaign/contactList/{{contactList}}?accountId={{accountId}}' \
--header 'auth: <token>' \
--header 'iid: st-0603182c-7ffb-53c3-b307-47ca14bxxxxx' \
--header 'accountid: 67777ce93e25326494exxxxx' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Renewal Due - May/June 2025"
    "description": "This list contains customers with services expiring in July 2025. It includes contact details and subscription info to help agents provide tailored support during live calls."
}'

​
Headers

HeaderDescriptionRequired/Optional
authJWT token for authentication.required
iidThe Application Id.required
accountIdThe Account Id.required

​
Body Parameters

ParameterDescriptionType
nameUpdated name of the contact list. Maximum 48 characters. Used for identification and UI display.string, optional
descriptionUpdated description of the contact list. Maximum 256 characters. Should explain the purpose or content of the list.string, optional

​
Sample Response

{
    "status": "success",
    "message": "Contact list Renewal Due - May/June 2025 updated successfully",
    "data": {
        "contactListId": "cl-718e888-3aca-4008-973e-6d79940xxxxx",
        "body": {
            "name": "Renewal Due - May/June 2025",
            "scope": [
                "campaign_management"
            ],
            "orgId": "o-f8b351e7-f83a-51bd-bd42-d5d4086xxxxx",
            "iId": "st-0603182c-7ffb-53c3-b307-47ca14bxxxxx",
            "listType": "call",
            "accountId": "67777ce93e25326494exxxxx",
            "updatedBy": "u-eb5bbee1-6af9-5b9a-b471-03a3fe4xxxxx"
        }
    }
}

​
Response Parameters

ParameterDescriptionType
statusIndicates the success or failure of the API call.string
messageMessage confirming the update operation.string
dataContains details of the updated contact list.object
data.contactListIdUnique identifier of the contact list.string
data.bodyObject with updated metadata of the contact list.object
data.body.nameName of the contact list.string
data.body.descriptionDescription of the contact list.string
data.body.scopeScope of the contact list.array
data.body.orgIdUnique identifier of the organization.string
data.body.iIdInstance ID associated with the request context.string
data.body.listTypeType of the list (for example, call, sms).string
data.body.accountIdIdentifier of the account to which the list belongs.string
data.body.updatedByIdentifier of the user who performed the update.string