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 SMS Campaign API Use this API to update an existing SMS campaign using the format, contact lists, experience flow, and dialing strategy.
Method PUT Endpoint https://{{host}}/campaign/api/v2/public/{{streamId}}/campaign/{{campaignId}}?accountId={{accountId}}&campaignType=smsContent-Type application/jsonAuthorization auth: {{JWT}} See How to generate the JWT Token .API Scope Campaign Management
Path Parameters Parameter Description Type hostEnvironment URL. For example: https://platform.kore.ai string, required streamIdBot ID or Stream ID. You can get it from the general settings page. string, required campaignIdUnique ID of the campaign. For example: cd-ed19e3c7-3682-5e72-a839-af9e0711xxxx string, required
Query Parameter Parameter Description Type campaignTypeType of campaign. Use "sms". string, required
Sample Request curl --location --request PUT 'https://{{host}}/campaign/api/v2/public/{{streamId}}/campaign/{{campaignId}}?accountId={{accountId}}&campaignType=sms' \ --header 'auth: <token>' \ --header 'Content-Type: application/json' \ --header 'iid: st-0603182c-7ffb-53c3-b307-47ca14bxxxxx' \ --header 'accountId: 67777ce93e25326494exxxxx' \ --data '{ "name": "Interactive Support SMS Campaign", "description": "Updated: This campaign sends an SMS with a link or instructions to interact with a bot. Customers can check order status, raise tickets, or get help—all via chat-enabled SMS.", "contactLists": [ "CL Only 2020 Dec 4" ], "priority": "5", "format": "advanced", "campaignType": "sms", "dialingStrategy": { "callerId": { "phoneNumber": "+9198607xxxxx" }, "callingHours": { "frequency": "WEEKLY", "timezone": "Asia/Kolkata", "days": [ { "day": "MO", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "TU", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "WE", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "TH", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "FR", "start": "9:00 AM", "end": "6:00 PM" } ] } }, "schedule": { "isSchedulingEnabled": false }, "experienceFlowName": "SMS Support Flow" }'
Header Description Required/Optional authJWT token for authentication. required iidThe Application Id. required accountIdThe Account Id. required
Body Parameters Parameter Description Type nameName of the SMS campaign. Used to identify the campaign across the platform. Max 48 characters. string, required descriptionDescription explaining the campaign’s objective (for example, enabling user interaction via SMS). Max 256 characters. string, required contactListsNames of predefined contact lists this campaign will target. At least one contact list name is required. array[string], required priorityCampaign priority. Higher values indicate higher execution priority. Must be one of: 1, 2, 3, 4, or 5. string, required formatMessage format type. "advanced" is typically used when personalized content or bot links are included. string, required campaignTypeType of campaign. Must be either 'voice' or 'sms'. string, required dialingStrategy.callerId.phoneNumberPhone number or sender ID used to send the SMS. Must be registered with the provider. string, required dialingStrategy.callingHours.frequencyFrequency of calling hours. Allowed values: 'WEEKLY', 'DAILY', or 'CUSTOM'. string, required dialingStrategy.callingHours.timezoneTimezone used to enforce sending hours. Example: "Asia/Kolkata". string, required dialingStrategy.callingHours.daysArray of allowed days and time blocks for sending SMS. Each entry includes: day, start (for example, "9:00 AM"), and end (for example, "6:00 PM"). Multiple allowed. array[object], required experienceFlowNameName of the experience flow triggered via SMS for interactive support. string, required
Sample Response { "status": "success", "message": "Campaign Interactive Support SMS Campaign details updated successfully", "data": { "_id": "cd-e7110489-a30a-5d1e-80ee-f246cc8xxxxx", "name": "Interactive Support SMS Campaign", "lname": "interactive support sms campaign", "description": "Updated: This campaign sends an SMS with a link or instructions to interact with an AI Agent. Customers can check order status, raise tickets, or get help—all via chat-enabled SMS.", "status": "Ready", "priority": "5", "dialingStrategy": { "callerId": { "phoneNumber": "+9198607xxxxx" }, "callingHours": { "frequency": "WEEKLY", "timezone": "Asia/Kolkata", "days": [ { "day": "MO", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "TU", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "WE", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "TH", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "FR", "start": "9:00 AM", "end": "6:00 PM" } ] } }, "experienceFlow": "cf-67447605-115e-5dd2-a676-e158cf3xxxxx", "isImported": false, "isFiltersEnabled": false, "createdAt": "2025-12-05T08:16:19.398Z", "updatedAt": "2025-12-05T08:57:17.709Z", "schedule": { "isSchedulingEnabled": false, "isRecurrenceEnabled": false }, "contactLists": [ "CL Only 2020 Dec 4" ], "format": "advanced" } }
Response Parameters Parameter Description Type _idUnique identifier for the campaign. string nameCampaign name. string lnameLowercase version of campaign name. string descriptionCampaign description. string statusCurrent campaign status. For example: Ready. string priorityCampaign priority. For example: 5. string dialingStrategyDialing configuration for the campaign. object dialingStrategy.callerIdCaller ID configuration. object dialingStrategy.callerId.phoneNumberCaller phone number in E.164 format. string dialingStrategy.callingHoursAllowed calling hours. object dialingStrategy.callingHours.frequencyFrequency of calls. For example: WEEKLY. string dialingStrategy.callingHours.timezoneTime zone used for calling hours. string dialingStrategy.callingHours.daysList of daily calling windows. array dialingStrategy.callingHours.days.dayDay of the week (for example, MO, TU). string dialingStrategy.callingHours.days.startStart time (for example, 9:00 AM). string dialingStrategy.callingHours.days.endEnd time (for example, 6:00 PM). string experienceFlowExperience flow ID assigned. string totalMessagesSentCount of messages sent. integer directionCampaign format type. For example: advanced. string createdAtCampaign creation timestamp in ISO format. string updatedAtLast update timestamp in ISO format. string scheduleScheduling settings for the campaign. object schedule.isSchedulingEnabledIndicates if scheduling is enabled for the campaign. boolean schedule.isRecurrenceEnabledIndicates if the campaign repeats automatically (daily, weekly, etc.). boolean campaignInstanceIdInternal campaign instance identifier. For example: cid-b1c6849b-b40f-550e-ace7-xxxx string contactListsList of contact list names used in the campaign. array data.formatSpecifies the message format (for example, advanced). string
