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

# Update a Study panel

> Moves a Study panel to LIVE, PAUSED, or COMPLETED. The status only decides whether entering respondents are admitted: it does not change the Survey on the customer's RepData account.



## OpenAPI

````yaml /reference/study-api-v2.json patch /v2/studies/{studyId}/panels/{panelId}
openapi: 3.1.0
info:
  title: Sprig Public API V2 — Studies
  version: 1.0.0
  description: >-
    Programmatically create and manage Sprig SURVEY, IN_PRODUCT_SURVEY, and
    FEEDBACK Studies, their Questions, Blocks, invitations, and translations.
  contact:
    name: Support
    email: support@sprig.com
servers:
  - url: https://api.sprig.com
security: []
tags:
  - name: Studies
    description: >-
      The root resource for a programmatically managed SURVEY,
      IN_PRODUCT_SURVEY, or FEEDBACK Study.
  - name: Questions
    description: Questions, with their nested options, owned by a Study.
  - name: Blocks
    description: >-
      Blocks and Pages; Pages are not supported for IN_PRODUCT_SURVEY or
      FEEDBACK Studies. Group skip and display logic live on the Block. Question
      logic is member display, plus skip logic only outside a Page.
  - name: Invitations
    description: >-
      Invitation codes for SURVEY Studies; invitations are not supported for
      IN_PRODUCT_SURVEY or FEEDBACK Studies.
  - name: Translations
    description: >-
      Per-locale translated content for a Study, and the asynchronous jobs that
      generate it. Job cancellation is best-effort and does not roll back
      committed output.
  - name: Panels
    description: >-
      Links between SURVEY Studies and Surveys on the customer's RepData
      account, with the entry URL each Survey sends respondents to.
  - name: Attributes
    description: Custom Attribute definitions available in the environment.
  - name: Targeting
    description: >-
      Event triggers and audience conditions for IN_PRODUCT_SURVEY and FEEDBACK
      Studies. FEEDBACK supports exactly one page-URL Event trigger with no
      properties or delay.
  - name: Events
    description: Existing tracked and page-URL Events available for Study targeting.
paths:
  /v2/studies/{studyId}/panels/{panelId}:
    patch:
      tags:
        - Panels
      summary: Update a Study panel
      description: >-
        Moves a Study panel to LIVE, PAUSED, or COMPLETED. The status only
        decides whether entering respondents are admitted: it does not change
        the Survey on the customer's RepData account.
      operationId: updateStudyPanel
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: studyId
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: panelId
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateStudyPanelInput'
      responses:
        '200':
          description: The updated Study panel.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudyPanel'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            The environment API key is missing or invalid, cannot access this
            resource, or the Study API is not available for the account.
        '404':
          description: The Study was not found, or the panel is not linked to that Study.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - EnvironmentApiKey: []
components:
  schemas:
    UpdateStudyPanelInput:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/StudyPanelStatus'
      required:
        - status
      additionalProperties: false
      description: The status to move the panel to.
    StudyPanel:
      type: object
      properties:
        id:
          type: string
          format: uuid
        provider:
          type: string
          enum:
            - REPDATA
        externalId:
          type: string
        status:
          $ref: '#/components/schemas/StudyPanelStatus'
        entryUrl:
          type: string
          description: >-
            Set as the entry link of the RepData Survey. It ends with a raw
            [%RDUD%].
        createdAt:
          type: string
          format: date-time
      required:
        - id
        - provider
        - externalId
        - status
        - entryUrl
        - createdAt
      description: >-
        A panel linking a SURVEY Study to a Survey on the customer's RepData
        account.
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: A machine-readable error code (e.g. STUDY_NOT_FOUND).
        message:
          type: string
          description: A human-readable description of the error.
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              path:
                type: string
              message:
                type: string
              resource:
                type: object
                properties:
                  type:
                    type: string
                  id:
                    type: string
                required:
                  - type
                  - id
                description: >-
                  The other resource this issue points at, when the issue is not
                  about the request itself.
            required:
              - code
              - message
          description: >-
            Per-field validation issues, present when the request itself was
            malformed.
      required:
        - code
        - message
      description: Error response returned by the Public API V2.
      title: API error
    StudyPanelStatus:
      type: string
      enum:
        - LIVE
        - PAUSED
        - COMPLETED
      description: >-
        LIVE admits respondents. PAUSED and COMPLETED send entering respondents
        back to the provider.
  securitySchemes:
    EnvironmentApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Use `API-Key YOUR_API_KEY`. The key selects the Production or
        Development environment.

````