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
Stop SMS Campaign API
Use this API to stop an active SMS campaign for a given stream ID and campaign ID.
| Method | POST |
|---|
| Endpoint | https://{{host}}/campaign/api/v1/public/{{IID}}/campaign/{{campaignId}}?campaignType={{campaignType}}&trigger={{trigger}} |
| Content-Type | application/json |
| Authorization | auth: {{JWT}} See How to generate the JWT Token |
| API Scope | Campaign Management |
Path Parameters
| Parameter | Description | Type |
|---|
host | Environment URL, for example, https://platform.kore.ai | string, required |
IId | The Application ID. | string, required |
campaignId | Unique identifier of the campaign to trigger. | string, required |
Query Parameters
| Parameter | Description | Type |
|---|
campaignType | Type of campaign. Use "sms" for SMS campaign. | string, required |
trigger | Action to perform. Use "stop" to stop the campaign. | string, required |
Sample Request
curl --location 'https://{{host}}/campaign/api/v1/public/{{IID}}/campaign/{{campaignType}}?campaignType={{campaignType}}&trigger={{trigger}}' \
--header 'auth: <token>' \
--header 'Content-Type: application/json' \
--header 'iid: st-0603182c-7ffb-53c3-b307-47ca14b9xxxx' \
--header 'accountId: 67777ce93e25326494e9xxxx' \
--data '{}
'
| Header | Description | Required/Optional |
|---|
auth | JWT token for authentication. | required |
iid | The Application Id. | required |
accountId | The Account Id. | required |
Sample Response
{
"status": "Stopped",
"message": "Campaign Stopped",
"updatedAt": "2025-06-26T14:45:07.956Z",
"campaignExecutionType": "NORMAL"
}
Response Body Parameters
| Parameter | Description | Type |
|---|
status | Indicates the current status of the campaign. For example, Stopped | string |
message | Success confirmation message. For example, Campaign Stopped | string |
updatedAt | ISO timestamp when the campaign was activated. | string |
campaignExecutionType | Type of campaign execution, such as NORMAL. | string |
