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

# Pause or resume a Slack connection

> Set ``is_active`` to pause deliveries to a Slack channel without dropping its access, or to resume them. Resuming a channel whose access was revoked (``token_valid: false``) does not restore delivery; reconnect it through ``POST /slack/connections/install-url/``. A connection that belongs to another organization is a ``404``. Requires an owner or manager role.



## OpenAPI

````yaml /openapi/openapi-integrations.json patch /integrations/api/v1/slack/connections/{connection_id}/
openapi: 3.1.0
info:
  title: Integrations API
  version: 1.0.0
  description: >
    Webhook endpoint management, event catalog, delivery tracking, and event
    replay, plus the POS and Slack connections an organization has made.


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    Generate API keys in **Settings > API Keys** in your dashboard, or via the
    Account API.

    Session-based (cookie) authentication is also accepted for browser-based
    access.


    ## Rate Limits


    | Tier        | Requests / minute | Requests / day |

    |-------------|-------------------|----------------|

    | Default     | 300               | 10,000         |

    | Custom      | Contact us        | Contact us     |


    Those windows are per key. Your plan also caps each organization per hour,
    across every key,

    login and session acting for it: 100 requests on Free (or while a
    subscription is lapsed),

    10,000 on Business. While a subscription is lapsed, any method other than
    `GET`, `HEAD` and

    `OPTIONS` returns `403`.


    Rate-limit headers are included on every response so callers can
    self-throttle without

    hitting our 429s ("informed governor"):


    - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400`

    - `RateLimit-Limit` — quota for the **most-restrictive** currently-active
    window

    - `RateLimit-Remaining` — requests left in that window

    - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew
    safe)


    Legacy `X-RateLimit-*` aliases are also emitted for back-compat.
    `X-RateLimit-Reset`

    keeps the absolute Unix-timestamp shape to avoid breaking existing
    consumers.


    When rate-limited, you receive `429 Too Many Requests` with a
    `retry_after_seconds` field

    in the error envelope and a `Retry-After` header.


    ## Pagination


    List endpoints return paginated results in this envelope:


    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "page_size": 25,
        "total_count": 342,
        "total_pages": 14,
        "has_next": true,
        "has_previous": false
      }
    }

    ```


    Use `?page=2&page_size=50` query parameters. Maximum page size is 100.


    ## Error Responses


    All errors conform to [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457)

    with `Content-Type: application/problem+json`:


    ```json

    {
      "type": "https://closient.com/docs/errors/not_found",
      "title": "Not Found",
      "status": 404,
      "detail": "The requested resource was not found.",
      "error_code": "not_found",
      "retryable": false,
      "timestamp": "2026-03-31T12:00:00+00:00"
    }

    ```


    Common error codes: `unauthorized` (401), `forbidden` (403), `not_found`
    (404),

    `validation_error` (422), `rate_limited` (429), `internal_error` (500).


    ## Versioning and Deprecation


    Every response from an operation in this document carries
    `Closient-API-Version` (its `info.version`).

    An operation marked `deprecated` answers with `Deprecation: @<Unix seconds>`

    ([RFC 9745](https://www.rfc-editor.org/rfc/rfc9745)), `Sunset: <HTTP-date>`
    once a

    retirement date is set ([RFC 8594](https://www.rfc-editor.org/rfc/rfc8594)),
    and

    `Link` entries for `rel="deprecation"`, `rel="sunset"` and
    `rel="successor-version"`.

    After its sunset it answers `410 Gone` naming the replacement. Policy:

    https://docs.closient.com/api-versioning
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
tags:
  - name: Webhook Endpoints
    description: Register and manage webhook delivery endpoints.
  - name: Webhook Event Catalog
    description: >-
      Discover every subscribable event type and the envelope versions
      available.
  - name: Webhook Deliveries
    description: Track and replay webhook delivery attempts.
  - name: Webhook Events
    description: >-
      Durable event log with cursor-based replay, for recovering from a
      subscriber outage.
  - name: POS Connections
    description: List and disconnect the organization's POS and e-commerce connections.
  - name: Slack Connections
    description: List, pause, resume and disconnect Slack channels, and start a connection.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /integrations/api/v1/slack/connections/{connection_id}/:
    patch:
      tags:
        - Slack Connections
      summary: Pause or resume a Slack connection
      description: >-
        Set ``is_active`` to pause deliveries to a Slack channel without
        dropping its access, or to resume them. Resuming a channel whose access
        was revoked (``token_valid: false``) does not restore delivery;
        reconnect it through ``POST /slack/connections/install-url/``. A
        connection that belongs to another organization is a ``404``. Requires
        an owner or manager role.
      operationId: update_slack_connection
      parameters:
        - in: path
          name: connection_id
          schema:
            description: >-
              ID of the Slack connection. Returned as the ``id`` field on every
              Slack connection response.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Connection Id
            type: string
          required: true
          description: >-
            ID of the Slack connection. Returned as the ``id`` field on every
            Slack connection response.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SlackConnectionUpdate'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlackConnectionOut'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '405':
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '422':
          description: Unprocessable Content
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - CookieGatedSessionAuth: []
components:
  schemas:
    SlackConnectionUpdate:
      description: Fields of a Slack connection a caller may change.
      examples:
        - is_active: false
      properties:
        is_active:
          description: >-
            ``false`` pauses deliveries to the channel without dropping its
            access; ``true`` resumes them.
          title: Is Active
          type: boolean
      required:
        - is_active
      title: SlackConnectionUpdate
      type: object
    SlackConnectionOut:
      description: >-
        A Slack channel the organization delivers to. The bot token is never
        part of the response.
      examples:
        - channel_id: C0EXAMPLE1
          channel_name: product-signals
          id: SBjSX6xUJPPHQKUXBpYX2C
          is_active: true
          purpose: signals
          signal_delivery_mode: per_signal
          team_id: T0EXAMPLE1
          team_name: Acme Outlet (Demo)
          token_valid: true
      properties:
        id:
          description: >-
            ID of the Slack connection. Returned as the ``id`` field on every
            Slack connection response.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Id
          type: string
        purpose:
          $ref: '#/components/schemas/SlackChannelPurposeEnum'
          description: What kind of events this channel receives.
        team_id:
          description: The Slack workspace ID.
          title: Team Id
          type: string
        team_name:
          description: The Slack workspace name, for display.
          title: Team Name
          type: string
        channel_id:
          description: The Slack channel ID.
          title: Channel Id
          type: string
        channel_name:
          description: The Slack channel name, for display, without a leading ``#``.
          title: Channel Name
          type: string
        is_active:
          description: >-
            Whether deliveries are sent to this channel. ``false`` when it was
            paused or disconnected, or when Slack revoked access.
          title: Is Active
          type: boolean
        token_valid:
          description: >-
            ``false`` once access has been revoked, by a disconnect or by Slack.
            Nothing is delivered in that state whatever ``is_active`` says;
            reconnect the channel through the install URL.
          title: Token Valid
          type: boolean
        signal_delivery_mode:
          $ref: '#/components/schemas/SlackSignalDeliveryModeEnum'
          description: >-
            For ``signals`` channels: send each Product Signal immediately, or
            hold for one daily digest.
      required:
        - id
        - purpose
        - team_id
        - team_name
        - channel_id
        - channel_name
        - is_active
        - token_valid
        - signal_delivery_mode
      title: SlackConnectionOut
      type: object
    ErrorOut:
      title: ErrorOut
      type: object
      description: RFC 9457 Problem Details error body.
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        error_code:
          type: string
        retryable:
          type: boolean
        timestamp:
          format: date-time
          type: string
      required:
        - type
        - title
        - status
        - detail
      examples:
        - type: https://closient.com/docs/errors/not_found
          title: Not Found
          status: 404
          detail: The requested resource was not found.
          error_code: not_found
          retryable: false
          timestamp: '2026-03-31T12:00:00+00:00'
    SlackChannelPurposeEnum:
      description: What kind of events a Slack channel receives.
      enum:
        - notifications
        - feedback
        - signals
        - founder
        - proof_of_brand
      title: SlackChannelPurposeEnum
      type: string
    SlackSignalDeliveryModeEnum:
      description: >-
        How a ``signals`` channel is delivered to: one message per Product
        Signal as it happens, or one daily digest.
      enum:
        - per_signal
        - digest_daily
      title: SlackSignalDeliveryModeEnum
      type: string
  securitySchemes:
    APIKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-API-Key
    OAuthTokenAuth:
      type: http
      scheme: bearer
    CookieGatedSessionAuth:
      type: apiKey
      in: cookie
      name: sessionid

````

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