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

​
Create Contact List API

Use this API to create a new contact list for use in passive voice campaigns.
MethodPOST
Endpointhttps://{{host}}/agentassist/api/v1/public/{{IID}}/campaign/contactList/createContactList
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
IIdThe Application ID.string, required

​
Sample Request

curl --location 'https://{{host}}/agentassist/api/v1/public/{{IID}}/campaign/contactList/createContactList' \
--header 'auth: <token>' \
--header 'Content-Type: application/json' \
--header 'iid: st-0603182c-7ffb-53c3-b307-47ca14b9xxxx' \
--header 'accountId: 67777ce93e25326494e9xxxx' \
--data '{
    "name1": "Renewal Due - July 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.",
    "source": "passiveApiIntegration",
    "allowDuplicates": true
}'

​
Headers

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

​
Body Parameters

ParameterDescriptionType
nameName of the contact list. Max 48 characters. Used to identify and display the list across the platform.string, required
descriptionDescription of the contact list. Max 256 characters. Should briefly explain the list’s purpose and audience.string, required
sourceData origin/source. Must be "passiveApi", indicating the list is populated via API rather than file/manual upload.string, required
allowDuplicatesWhether to allow duplicate contact entries in the list. Defaults to false if not provided. Must be a boolean value.boolean, optional

​
Sample Response

{
    "status": "success",
    "message": "Contact list Contact list of Passive June 27 created successfully",
    "data": {
        "isActive": true,
        "name": "Contact list of Passive June 27",
        "description": "contact list Description",
        "totalRecordCount": 0,
        "status": "Ready",
        "createdBy": "u-4baef569-f6c2-5486-a119-96857249xxxx",
        "updatedBy": "u-4baef569-f6c2-5486-a119-96857249xxxx",
        "mapping": {
            "firstName": "firstName",
            "lastName": "lastName",
            "phoneNumber": "phoneNumber",
            "timeZone": "timeZone",
            "uniqueId": "uniqueId"
        },
        "isListInUse": false,
        "listType": "call",
        "campaignInUse": [],
        "source": "passiveApi",
        "apiConfigurations": {
            "dataSyncMode": "allowDuplicates"
        },
        "files": [],
        "createdAt": "2025-06-27T07:37:17.489Z",
        "updatedAt": "2025-06-27T07:37:17.489Z",
        "_id": "cl-4db9a03-07a3-4009-973a-b8940e81xxxx",
        "allowDuplicates": true
    }
}

​
Response Body Parameters

ParameterDescriptionType
_idUnique ID of the contact liststring
nameName of the contact liststring
descriptionDescription of the contact liststring
statusCurrent state of the contact list. Usually Readystring
isActiveIndicates if the contact list is activeboolean
totalRecordCountNumber of records currently in the listnumber
sourceSource of list creation. For passive API, the value is passiveApistring
allowDuplicatesIndicates if duplicate contact records are allowedboolean
createdAtTimestamp when the list was created (ISO format)string
updatedAtTimestamp when the list was last updated (ISO format)string
createdByInternal ID of the user who created the liststring
updatedByInternal ID of the user who last updated the liststring
mappingField mapping for contact dataobject
apiConfigurationsContains passive API sync configuration (for example, dataSyncMode)object
apiConfigurations.dataSyncModeDescribes how the API handles duplicate entries (allowDuplicates)string
listTypeType of list. Value is call for voice campaignsstring
isListInUseIndicates if the contact list is currently associated with any campaignboolean
campaignInUseList of campaigns (IDs) currently using this list (empty if unused)array
filesList of file objects, if any uploaded via UI or API (empty for passive API)array