To create bulk contact from a CSV file with the given stream Id.
Method | POST |
Endpoint | https://{host}/agentassist/api/v1/public/{{streamId}}/contacts/import-contacts |
Content Type | application/json |
Authorization | auth: {{JWT}} See How to generate the JWT Token. |
API Scope | Configuration |
Path Parameters
Parameter | Description | Type |
---|---|---|
host | Environment URL, for example, https://smartassist.kore.ai | String, Required |
BotId | BotId or StreamId. You can access it from the General Settings page of the bot. | String, Required |
contacts | Contact details, for example, firstName, salutation, cellPhoneNumber, cellPhoneCountryCode, cellPhoneExtension. | String, Required |
Sample CSV File
Sample Request
curl --location --request POST 'https://smartassist.kore.ai/agentassist/api/v1/public/st-733b03fb-667c-58d4-89ab-9d13f63fxxxx/contacts/import-contacts' \ --header 'authority: smartassist.kore.ai' \ --header 'accept: application/json, text/plain, */*' \ --header 'accept-language: en-GB,en;q=0.6' \ --header 'accountid: 63c7ebae6a2aef36de8fxxxx' \ --header 'app-language: en' \ --header 'content-type: application/json;charset=UTF-8' \ --header 'cookie: mp_047a11cecb5356a4a4d5b3807d280766_mixpanel=%7B%22distinct_id%22%3A%20% 22185c4ee76476b6-06c5d613d9143b-1e462c6d-1fa400-185c4ee764897d%22%2C%22%24device_id%22%3A%20%22185c4ee76476b6-06c5d613d9143 b-1e462c6d-1fa400-185c4ee764897d%22%7D; mp_7888bdd5fedfd65f44bb9a3100fa9e80_mixpanel=%7B%22distinct_id%22%3A%20%22185c96da 2076ba-0f4b0a432b9049-1e462c6d-1fa400-185c96da208b46%22%2C%22%24device_id%22%3A%20%22185c96da2076ba-0f4b0a432b9049-1e462c6 d-1fa400-185c96da208b46%22%7D' \ --header 'referer: https://smartassist.kore.ai/desktop/console' \ --header 'sec-ch-ua: "Not_A Brand";v="99", "Brave";v="109", "Chromium";v="109"' \ --header 'sec-ch-ua-mobile: ?0' \ --header 'sec-ch-ua-platform: "Linux"' \ --header 'sec-fetch-dest: empty' \ --header 'sec-fetch-mode: cors' \ --header 'sec-fetch-site: same-origin' \ --header 'sec-gpc: 1' \ --header 'smartassist: true' \ --header 'state: configured' \ --header 'user-agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36' \ --header 'x-request-id: ed914d3f-9985-47a5-8ab2-84573c68xxxx' \ --header 'x-timezone-offset: -330' \ --header 'auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiY3MtMTY5ZmVhZGItYzU3Mi01NTZlLWEzODYtNjgxNmMxNzM3YzQ2In0.3hb7YvEv3W piCYcLo9PUpKLmy05cBvk1D1ZJt0UjhQU' \ --form 'result_file=@"/home/johnsmith/Documents/john/sample.csv"'
Body Parameters
Parameter | Description | Type |
---|---|---|
firstName | The first name of the contact. | String, Required |
lastName | The last name of the contact. | String, Required |
salutation | The salutation (Mr. or Mrs.) of the contact. | String, Required |
cellPhoneNumber | The phoneNumber of the contact. |
String, Required |
cellPhoneCountryCode | The countryCode of the contact | String, Required |
cellPhoneExtension | The extension of the contact. | String, Required |
Sample Response
[ { "status": "ACTIVE", "firstName": "john", "lastName": "doe", "salutation": "Mr", "accountId": "63ab016b0d909c22b2daxxxx", "orgId": "o-dd99e2e4-476f-5aa6-90ad-bd7a0b9bxxxx", "createdBy": "u-79cda73a-5947-536f-a1cc-3e939e84xxxx", "cellPhone": { "phoneNumber": "+9198765xxxxx", "countryCode": "+91", "extension": "+" }, "fullName": "john doe", "address": [], "twitterDetails": [], "createdAt": "2023-01-18T10:53:35.622Z", "updatedAt": "2023-01-18T10:53:35.622Z", "id": "63c7cfaf196ce928529bxxxx" }, { "status": "ACTIVE", "firstName": "jane", "lastName": "doe", "salutation": "Mrs", "accountId": "63ab016b0d909c22b2daxxxx", "orgId": "o-dd99e2e4-476f-5aa6-90ad-bd7a0b9bxxxx", "createdBy": "u-79cda73a-5947-536f-a1cc-3e939e84xxxx", "cellPhone": { "phoneNumber": "+9112345xxxxx", "countryCode": "+91", "extension": "91" }, "fullName": "jane doe", "address": [], "twitterDetails": [], "createdAt": "2023-01-18T10:53:35.622Z", "updatedAt": "2023-01-18T10:53:35.622Z", "id": "63c7cfaf196ce928529bxxxx" } ]