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

# Remove clients from a pipeline

> Remove one or more clients from the pipeline.

Takes client IDs (the same IDs returned by *List clients in a pipeline*).
Each client's active pipeline record is archived; the contact itself is
kept.



## OpenAPI

````yaml POST /api/v2/public/salesflow/pipelines/{pipeline_id}/clients/remove
openapi: 3.1.0
info:
  title: Dialtu Public API
  version: '2.0'
  description: >-
    Programmatic access to your Dialtu account: schedule AI voice calls, create
    contacts, push leads into Salesflow pipelines, book calendar appointments
    and read WhatsApp conversation history.


    Every request is authenticated with an API key created in the dashboard
    under **Settings → API Keys**, sent as `Authorization: Bearer pk_...`.
servers:
  - url: https://api.dialtu.com
    description: Production
  - url: https://api.stg.dialtu.com
    description: Staging
security:
  - ApiKeyBearer: []
tags:
  - name: Calls
    description: Schedule outbound AI voice calls.
  - name: Clients
    description: Create contacts in your account.
  - name: Salesflow
    description: Push leads into a pipeline through an API input node.
  - name: Salesflow pipelines
    description: Read a pipeline's stages and add, move or remove clients.
  - name: Calendar
    description: Check bookable capacity, book appointments and manage waiting lists.
  - name: WhatsApp
    description: Read-only conversation history and transcripts.
paths:
  /api/v2/public/salesflow/pipelines/{pipeline_id}/clients/remove:
    post:
      tags:
        - Salesflow pipelines
      summary: Remove clients from a pipeline
      description: >-
        Remove one or more clients from the pipeline.


        Takes client IDs (the same IDs returned by *List clients in a
        pipeline*).

        Each client's active pipeline record is archived; the contact itself is

        kept.
      operationId: removePipelineClients
      parameters:
        - in: path
          name: pipeline_id
          schema:
            description: >-
              ID of the pipeline. Shown in the Salesflow editor URL and in the
              pipeline settings.
            title: Pipeline Id
            type: integer
          required: true
          description: >-
            ID of the pipeline. Shown in the Salesflow editor URL and in the
            pipeline settings.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicRemoveClientsFromPipelineSchema'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicPipelineOperationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicPipelineErrorResponse'
        '401':
          description: Missing, malformed or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailErrorResponse'
              examples:
                missing_header:
                  summary: No Authorization header
                  value:
                    detail: Unauthorized
                invalid_key:
                  summary: Unknown or revoked key
                  value:
                    detail: Invalid or expired API key. Please check your credentials.
        '422':
          description: The request did not match the documented schema.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestValidationError'
              example:
                detail:
                  - type: missing
                    loc:
                      - body
                      - payload
                      - phone_number
                    msg: Field required
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicPipelineErrorResponse'
      security:
        - ApiKeyBearer: []
components:
  schemas:
    PublicRemoveClientsFromPipelineSchema:
      description: Remove clients from a pipeline.
      properties:
        client_ids:
          description: IDs of the clients to remove.
          items:
            type: integer
          title: Client Ids
          type: array
      required:
        - client_ids
      title: PublicRemoveClientsFromPipelineSchema
      type: object
    PublicPipelineOperationResponse:
      description: Response for pipeline add/remove/move operations.
      properties:
        status:
          const: success
          description: Response status
          title: Status
          type: string
        message:
          description: Human-readable message
          title: Message
          type: string
        success_count:
          default: 0
          description: Clients processed successfully.
          title: Success Count
          type: integer
        skipped_count:
          default: 0
          description: Clients skipped (already on the pipeline, or not found on it).
          title: Skipped Count
          type: integer
      required:
        - status
        - message
      title: PublicPipelineOperationResponse
      type: object
    PublicPipelineErrorResponse:
      description: Error response for pipeline operations.
      properties:
        status:
          const: error
          description: Error status
          title: Status
          type: string
        error_code:
          description: Machine-readable error code
          title: Error Code
          type: string
        message:
          description: Human-readable error message
          title: Message
          type: string
      required:
        - status
        - error_code
        - message
      title: PublicPipelineErrorResponse
      type: object
    DetailErrorResponse:
      description: 'Plain error body: `{"detail": "..."}`. No `error_code` is included.'
      properties:
        detail:
          description: Human-readable reason for the failure.
          title: Detail
          type: string
      required:
        - detail
      title: DetailErrorResponse
      type: object
    RequestValidationError:
      title: RequestValidationError
      type: object
      description: >-
        Returned when the request body, query string or path could not be parsed
        against the documented schema. Fix the listed fields and retry.
      properties:
        detail:
          type: array
          title: Detail
          description: One entry per invalid field.
          items:
            $ref: '#/components/schemas/RequestValidationErrorItem'
      required:
        - detail
    RequestValidationErrorItem:
      title: RequestValidationErrorItem
      type: object
      properties:
        loc:
          type: array
          title: Loc
          description: >-
            Where the problem is: the first element is `body`, `query` or
            `path`, followed by the field path.
          items:
            anyOf:
              - type: string
              - type: integer
        msg:
          type: string
          title: Msg
          description: What is wrong with the value.
        type:
          type: string
          title: Type
          description: >-
            Machine-readable validation error type, e.g. `missing` or
            `int_parsing`.
      required:
        - loc
        - msg
        - type
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: pk_...
      description: >-
        API key created in the dashboard under **Settings → API Keys**. Send it
        as `Authorization: Bearer pk_...`.

````