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

# Pause Workflow

> Stops future workflow dispatch and queues reconciliation. Managed HubSpot fields can be cleared when no other enabled rule qualifies. Pausing is not equivalent to stopping provider writeback or retaining CRM values on trial expiry.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/workflows/{identifier}/pause
openapi: 3.1.0
info:
  description: >-
    Selected current-source customer operations under preview. Access and
    integrations require workspace enablement; this is not a
    general-availability, onboarding or external-client registration promise.
    Request and query models come from code; many success responses have no
    response model and are intentionally untyped.
  title: Gather customer API — preview
  version: 0.1.0-preview
servers:
  - url: https://workspace.example.com
security: []
tags:
  - name: Governed data
  - name: HubSpot
  - name: Reviewed workflows
  - name: Rules and previews
  - name: Website preview
  - name: Workspace and observations
paths:
  /v1/workflows/{identifier}/pause:
    post:
      tags:
        - Reviewed workflows
      summary: Pause Workflow
      description: >-
        Stops future workflow dispatch and queues reconciliation. Managed
        HubSpot fields can be cleared when no other enabled rule qualifies.
        Pausing is not equivalent to stopping provider writeback or retaining
        CRM values on trial expiry.
      operationId: customer_post_v1_workflows_identifier_pause
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            format: uuid
            title: Identifier
            type: string
        - description: >-
            Required for browser-session mutations. Origin must exactly match
            the workspace; read the CSRF token from GET /v1/me using the browser
            session. A bearer-authenticated /v1/me response has csrf_token=null.
            Not required for bearer-token-only requests.
          in: header
          name: Origin
          required: false
          schema:
            type: string
        - description: >-
            Required for browser-session mutations. Origin must exactly match
            the workspace; read the CSRF token from GET /v1/me using the browser
            session. A bearer-authenticated /v1/me response has csrf_token=null.
            Not required for bearer-token-only requests.
          in: header
          name: X-CSRF-Token
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '401':
          description: Missing, expired or invalid workspace authentication.
        '403':
          description: >-
            Missing permission, browser-session requirement or CSRF validation
            failure.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '423':
          description: Workspace lifecycle currently denies activity.
        '503':
          description: Workspace control or required dependency unavailable.
      security:
        - TenantBearer: []
        - TenantSession: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    TenantBearer:
      bearerFormat: JWT
      description: >-
        Organization-bound Auth0 API access token. Required permissions are
        listed per operation; this does not offer API-key or client-registration
        issuance.
      scheme: bearer
      type: http
    TenantSession:
      description: >-
        Production host-only browser session. Read csrf_token from GET /v1/me
        using this session; bearer authentication returns a null CSRF token and
        takes precedence over cookies. Session mutations require exact Origin
        and X-CSRF-Token. Development uses signal_session.
      in: cookie
      name: __Host-signal_session
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.