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

# Pause Workflow

> Pauses the active workflow for the specified debtor, suppressing outbound communications.



## OpenAPI

````yaml PATCH /workflow/{debtorId}/pause
openapi: 3.0.1
info:
  title: CollectWise API
  description: >-
    An API for managing debtors, tracking statuses, and automating debt
    collection processes
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://collectwiseapi.com
security:
  - apiKey: []
paths:
  /workflow/{debtorId}/pause:
    patch:
      summary: Pause a debtor's workflow
      description: >-
        Pauses the active workflow for the specified debtor, suppressing
        outbound communications.
      parameters:
        - name: debtorId
          in: path
          required: true
          description: Unique identifier of the debtor
          schema:
            type: string
      responses:
        '200':
          description: Workflow paused successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Debtor's workflow paused
                  paused:
                    type: boolean
                    example: true
        '400':
          description: Debtor ID is required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Debtor not found or not enrolled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Failed to pause workflow
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
          description: Error code
        message:
          type: string
          description: Error message
      example:
        code: 400
        message: 'Invalid input: debtorName is required'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: collectwise_key

````