> ## Documentation Index
> Fetch the complete documentation index at: https://docs.revenueable.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Terminate Specific Numbers in Campaign

> Terminates calls to specific mobile numbers within a campaign. Useful for stopping calls to particular contacts in a campaign.

## Terminate Campaign Numbers

Stop calls to specific phone numbers within a particular campaign. This gives you precise control to remove individual contacts from an active campaign.

<Warning>
  **Targeted Termination**: This only affects the specified numbers within the given campaign. The same numbers in other campaigns will continue.
</Warning>

## When to Use This

* **Customer Requests**: When contacts ask to be removed from calls
* **Data Quality**: Remove invalid or problematic numbers from campaign
* **Compliance**: Honor do-not-call requests for specific numbers
* **Selective Control**: Keep campaign running but exclude certain contacts
* **A/B Testing**: Stop calls to control group numbers

## Perfect For

### Customer Opt-Outs

Quickly remove customers who requested to stop receiving calls:

```json theme={null}
{
  "campaign_id": "0b52ca2b-7767-4cb5-ac4c-b2a4f892a856",
  "mobile_numbers": ["+918882876897", "+918882876898"]
}
```

### Data Cleanup

Remove invalid or problematic numbers while keeping campaign active.

### Compliance Management

Honor do-not-call requests without stopping entire campaign.

## Important Details

### Number Format

* ✅ Include country code: `+918882876897`
* ✅ Use international format: `+1234567890`
* ❌ Don't use local format: `8882876897`

### Limitations

* **Maximum**: 100 numbers per request
* **Scope**: Only affects specified campaign
* **Status**: Only terminates registered/retry calls

### What Happens

* **Immediate**: Queued calls to these numbers are cancelled
* **Retry Calls**: Scheduled retries are also cancelled
* **Other Campaigns**: Same numbers in other campaigns continue
* **Completed Calls**: Already finished calls remain in history

<Info>
  **Pro Tip**: Use this endpoint to implement real-time opt-out functionality in your application. Customers can request removal and you can immediately stop their calls.
</Info>

## Response

Successful termination returns:

```json theme={null}
{
  "message": "Calls terminated successfully!"
}
```

The response doesn't specify how many calls were actually terminated, but all matching calls for the provided numbers within the campaign will be stopped.


## OpenAPI

````yaml patch /campaign/terminate/campaign-numbers
openapi: 3.0.0
info:
  title: Revenueable AI API Documentation
  description: >-
    This is the documentation for the Revenueable AI APIs. The Revenueable AI
    API follows RESTful principles, making it intuitive and easy to integrate
    with your applications. All API requests should be made to the base URL. The
    API accepts and returns data in JSON format. Ensure your requests include
    the appropriate Content-Type header for POST and PATCH requests.
  version: 2.0.0
servers:
  - url: https://prod-api.revenueable.ai/ca/api/v0
security: []
tags:
  - name: workspace
    description: Endpoints for managing your workspace.
  - name: agent
    description: Endpoints for managing assistants (agents).
  - name: calling
    description: Endpoints for making and managing calls.
  - name: campaign
    description: Endpoints for managing campaigns.
  - name: analytics
    description: Endpoints for accessing call analytics and performance metrics.
  - name: termination
    description: Endpoints for terminating active calls using different methods.
  - name: knowledgebase
    description: Endpoints for managing knowledge bases.
paths:
  /campaign/terminate/campaign-numbers:
    patch:
      tags:
        - termination
      summary: Terminate Specific Numbers in Campaign
      description: >-
        Terminates calls to specific mobile numbers within a campaign. Useful
        for stopping calls to particular contacts in a campaign.
      operationId: terminateCallsByCampaignNumbers
      parameters:
        - name: X-API-KEY
          in: header
          description: (Required) Your Revenueable AI API key.
          required: true
          schema:
            type: string
            example: 7251cb4b-3373-43a4-844c-b27a1d45e0c9
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - campaign_id
                - mobile_numbers
              properties:
                campaign_id:
                  type: string
                  description: (Required) ID of the campaign
                  example: 0b52ca2b-7767-4cb5-ac4c-b2a4f892a856
                mobile_numbers:
                  type: array
                  items:
                    type: string
                  description: >-
                    (Required) Array of mobile numbers to terminate within the
                    campaign (max 100)
                  example:
                    - '+918882876897'
                    - '+918882876898'
      responses:
        '200':
          description: Calls terminated successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Calls terminated successfully!
        '400':
          description: Bad Request - Invalid parameters or no terminable calls found.
        '401':
          description: Unauthorized - Invalid or missing API key.

````