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

# Edit, pause or resume a schedule

> Activating a schedule, or changing the models of an active one, checks that its queries can run on those models.



## OpenAPI

````yaml https://api.mentionlab.io/api/docs/v2-json patch /api/v2/projects/{projectId}/recurrence-settings/{recurrenceSettingId}
openapi: 3.0.0
info:
  title: MentionLab Public API v2
  description: ''
  version: 0.6.27-rc
  contact: {}
servers:
  - url: https://api.mentionlab.io
security: []
tags: []
paths:
  /api/v2/projects/{projectId}/recurrence-settings/{recurrenceSettingId}:
    patch:
      tags:
        - Recurrence settings
      summary: Edit, pause or resume a schedule
      description: >-
        Activating a schedule, or changing the models of an active one, checks
        that its queries can run on those models.
      operationId: ProjectRecurrenceSettingsV2Controller_update_v2
      parameters:
        - name: recurrenceSettingId
          required: true
          in: path
          schema:
            type: string
        - name: x-project-id
          in: header
          description: Project ID to specify the project context
          required: true
          schema:
            type: string
        - name: projectId
          required: true
          in: path
          schema:
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRecurrenceSettingV2Dto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectRecurrenceSettingV2Response'
        '400':
          description: >-
            The request failed validation — the body, query or path parameters
            are malformed or out of range.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: The request is missing valid authentication credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: >-
            The authenticated principal lacks the required permission, or access
            to the requested organisation/project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
components:
  schemas:
    UpdateRecurrenceSettingV2Dto:
      type: object
      properties:
        name:
          type: string
          maxLength: 100
          description: Unique within the project
          example: Weekly EU roundup
        cron:
          type: string
          description: UTC hour-granular cron, or "every:Nh@HH:00[/YYYY-MM-DD]"
          example: 0 6 * * *
        status:
          type: string
          enum:
            - active
            - paused
          description: Active fires on schedule, paused does not
        llmProviders:
          description: Raw model names
          example:
            - claude-haiku-latest
            - scp-ml-chatgpt
          uniqueItems: true
          type: array
          items:
            type: string
        executionCount:
          type: number
          minimum: 1
          maximum: 100
          description: Runs per query per fire
          example: 3
    ProjectRecurrenceSettingV2Response:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Identifies the schedule in the pause and resume route
        name:
          type: string
          description: Label the project gave the schedule, unique within it
        cron:
          type: string
          description: UTC cron
        status:
          type: string
          enum:
            - active
            - paused
          description: Active fires on the cron, paused never fires and reports no next run
        nextRunAt:
          type: string
          format: date-time
          description: Next fire time; absent when paused or none within 32 days
        llmProviders:
          description: Raw model names
          type: array
          items:
            type: string
        executionCount:
          type: number
          description: Runs per query per fire
        queriesCount:
          type: number
          description: Queries attached to the schedule, each run on every fire
        createdAt:
          type: string
          format: date-time
          description: When the schedule was created, not when it last fired
      required:
        - id
        - name
        - cron
        - status
        - llmProviders
        - executionCount
        - queriesCount
        - createdAt
    ApiErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code of the error.
          example: 400
        message:
          type: string
          description: >-
            Human-readable description of the error. Validation failures return
            an array of per-field validation errors instead of a single string.
          example: Validation failed
        error:
          type: string
          description: Short name of the HTTP error.
          example: Bad Request
      required:
        - statusCode

````

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