> ## 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.

# Stop SMS Campaign v2

<Badge icon="arrow-left" color="gray">[Back to API List](/ai-for-service/apis/contact-center/api-list)</Badge>

# 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/v2/public/{{streamId}}/campaign//trigger/{{campaignId}}?accountId={{accountId}}\&campaignType=sms\&trigger=stop` |
| Content-Type  | application/json                                                                                                                                |
| Authorization | auth: {{JWT}} See [How to generate the JWT Token](/ai-for-service/apis/automation/api-introduction#generating-the-jwt-token)                    |
| API Scope     | Campaign Management                                                                                                                             |

## Path Parameters

| **Parameter** | **Description**                                                     | **Type**         |
| :------------ | :------------------------------------------------------------------ | :--------------- |
| `host`        | Environment URL, for example, `https://platform.kore.ai`            | string, required |
| `streamId`    | Bot ID or Stream ID. You can get it from the general settings page. | 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/v2/public/{{streamId}}/campaign//trigger/{{campaignId}}?accountId={{accountId}}&campaignType=sms&trigger=stop' \
--header 'auth: <token>' \
--header 'accountid: 67777ce93e25326494xxxxx' \
--header 'iid: st-0603182c-7ffb-53c3-b307-47ca14bxxxxx' \
--header 'Content-Type: application/json' \
--data '{}
'
```

## Headers

| **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-12-05T12:07:54.225Z",
    "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   |