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

# Pause Auto-Claim Schedule

> Stops a schedule from claiming on its next fires without deleting it; its job stays scheduled so it can be resumed. Requires the auto-claim-rewards capability.



## OpenAPI

````yaml POST /api/v1/accounts/{account-id}/auto-claims/{schedule-id}/pause
openapi: 3.1.0
info:
  title: Crown API & Webhooks
  version: 1.0.0
  description: >-
    Open API 3 docs for Crown API


    Webhook events that Crown will POST to your configured endpoint URL. All
    webhooks expect a 200 OK response. Payloads use kebab-case for all keys to
    match the Crown API conventions.
servers:
  - url: https://app.crown-brlv.com
    description: Production server
security: []
paths:
  /api/v1/accounts/{account-id}/auto-claims/{schedule-id}/pause:
    post:
      summary: Pause an auto-claim schedule
      description: >-
        Stops a schedule from claiming on its next fires without deleting it;
        its job stays scheduled so it can be resumed. Requires the
        auto-claim-rewards capability.
      parameters:
        - in: path
          name: account-id
          required: true
          schema:
            type: string
            format: uuid
        - in: path
          name: schedule-id
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Auto-claim schedule paused
          content:
            application/json:
              schema:
                type: object
                properties:
                  auto-claim-schedule:
                    type: object
                    properties:
                      last-run-at:
                        oneOf:
                          - type: string
                          - type: 'null'
                        description: Timestamp of the last run, or null
                      scope:
                        type: string
                        enum:
                          - wallet
                          - account
                        description: >-
                          Whether the schedule claims account-wide or for a
                          single wallet
                      cron:
                        type: string
                        description: UNIX cron expression
                        example: 0 9 * * *
                      target-asset-code:
                        type: string
                        enum:
                          - brl
                          - brlv
                        description: Destination asset for each claim
                      max-amount:
                        type: string
                        format: decimal
                        description: Maximum amount claimed each run
                      id:
                        type: string
                        format: uuid
                        description: Auto-claim schedule unique identifier
                      created-at:
                        type: string
                        description: Creation timestamp
                      enabled:
                        type: boolean
                        description: Whether the schedule is active
                      wallet-address:
                        oneOf:
                          - type: string
                          - type: 'null'
                        description: >-
                          Target wallet address when scope is 'wallet',
                          otherwise null
                    additionalProperties: false
                    required:
                      - last-run-at
                      - scope
                      - cron
                      - target-asset-code
                      - max-amount
                      - id
                      - created-at
                      - enabled
                      - wallet-address
                    description: The auto-claim schedule
                additionalProperties: false
                required:
                  - auto-claim-schedule
        '400':
          description: Bad request - Invalid input parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type: string
                    additionalProperties: false
                    required:
                      - type
                      - message
                      - code
                    description: Bad request error details
                additionalProperties: false
                required:
                  - error
        '403':
          description: Forbidden - Access denied
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type: string
                    additionalProperties: false
                    required:
                      - type
                      - message
                      - code
                    description: Forbidden access error details
                additionalProperties: false
                required:
                  - error
        '404':
          description: Not found - Resource does not exist
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type: string
                    additionalProperties: false
                    required:
                      - type
                      - message
                      - code
                    description: Resource not found error details
                additionalProperties: false
                required:
                  - error
        '422':
          description: Unprocessable entity - Validation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type: string
                    additionalProperties: false
                    required:
                      - type
                      - message
                      - code
                    description: Validation error details
                additionalProperties: false
                required:
                  - error

````