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

# Resume Study

> Resume a paused study (relaunches the panel for the remaining target).



## OpenAPI

````yaml /api-reference/openapi.json post /api/public/v1/studies/{study_id}/resume
openapi: 3.1.0
info:
  title: User Intuition Public API
  description: >-
    ## Public Integration API


    Programmatic access to User Intuition for external integrators: manage
    studies, participants, interviews, reports, and panels.


    ### Authentication


    All endpoints require a Bearer token — either an API key (prefixed `ui_sk_`,
    created in the dashboard) or a dashboard JWT:


    ```

    Authorization: Bearer <ui_sk_… or JWT>

    ```


    ### Base URLs


    - **Production:** `https://api.userintuition.ai`

    - **Staging:** `https://staging.userintuition.ai`


    ### Support


    For API support, contact support@userintuition.ai
  version: 1.0.0
  contact:
    name: User Intuition Support
    email: support@userintuition.ai
servers:
  - url: https://api.userintuition.ai
    description: Production
  - url: https://staging.userintuition.ai
    description: Staging
security:
  - BearerAuth: []
paths:
  /api/public/v1/studies/{study_id}/resume:
    post:
      tags:
        - public-studies
      summary: Resume Study
      description: Resume a paused study (relaunches the panel for the remaining target).
      operationId: resumeStudy
      parameters:
        - name: study_id
          in: path
          required: true
          schema:
            type: string
            title: Study Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicStudy'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PublicStudy:
      properties:
        id:
          type: string
          title: Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        study_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Study Type
          description: Study-type template slug
        recruiting_method:
          anyOf:
            - type: string
            - type: 'null'
          title: Recruiting Method
          description: panel or byop
        interview_format:
          anyOf:
            - type: string
              enum:
                - chat
                - video
                - voice
            - type: 'null'
          title: Interview Format
          description: chat, video, or voice
        voice:
          anyOf:
            - type: string
              enum:
                - male
                - female
            - type: 'null'
          title: Voice
          description: male or female
        language:
          anyOf:
            - type: string
            - type: 'null'
          title: Language
          description: Interview language code, e.g. 'en'
        byop_config:
          $ref: '#/components/schemas/PublicByopConfigOut'
        study_link:
          anyOf:
            - type: string
            - type: 'null'
          title: Study Link
          description: Universal interview link for the study
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
        study_plan:
          anyOf:
            - $ref: '#/components/schemas/PublicStudyPlanOut'
            - type: 'null'
        screener_questions:
          anyOf:
            - items:
                $ref: '#/components/schemas/PublicScreenerQuestion'
              type: array
            - type: 'null'
          title: Screener Questions
        targeting_attributes:
          anyOf:
            - items:
                $ref: '#/components/schemas/PublicTargetingAttribute'
              type: array
            - type: 'null'
          title: Targeting Attributes
        total_invites:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total Invites
        total_calls:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total Calls
        quality_calls:
          anyOf:
            - type: integer
            - type: 'null'
          title: Quality Calls
          description: Number of quality interviews
      type: object
      required:
        - id
      title: PublicStudy
      description: Full study shape returned by get-by-id (includes the heavy fields).
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PublicByopConfigOut:
      properties:
        incentive_amount:
          anyOf:
            - type: number
            - type: 'null'
          title: Incentive Amount
        is_incentives_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Incentives Enabled
        auto_send_incentives:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Auto Send Incentives
      type: object
      title: PublicByopConfigOut
    PublicStudyPlanOut:
      properties:
        objectives:
          anyOf:
            - type: string
            - type: 'null'
          title: Objectives
        conversation_flow:
          anyOf:
            - type: string
            - type: 'null'
          title: Conversation Flow
        background:
          anyOf:
            - type: string
            - type: 'null'
          title: Background
        learning_goals:
          anyOf:
            - type: string
            - type: 'null'
          title: Learning Goals
        key_questions:
          anyOf:
            - type: string
            - type: 'null'
          title: Key Questions
        study_specific_rules:
          anyOf:
            - type: string
            - type: 'null'
          title: Study Specific Rules
      type: object
      title: PublicStudyPlanOut
      description: >-
        Response variant — all sections optional (a study's stored prompt may
        not

        contain every section).
    PublicScreenerQuestion:
      properties:
        id:
          type: string
          title: Id
        text:
          type: string
          title: Text
        type:
          type: string
          title: Type
          description: single_select, multi_select, or text_input
        order:
          type: integer
          title: Order
        options:
          items:
            $ref: '#/components/schemas/PublicScreenerOption'
          type: array
          title: Options
        text_values:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Text Values
        disallowed_text_values:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Disallowed Text Values
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
      type: object
      required:
        - id
        - text
        - type
        - order
      title: PublicScreenerQuestion
    PublicTargetingAttribute:
      properties:
        qualification_id:
          type: integer
          title: Qualification Id
          description: Qualification id (from GET /targeting-attributes)
        allowed_options:
          items:
            type: integer
          type: array
          title: Allowed Options
          description: option_ids to allow
        disallowed_options:
          items:
            type: integer
          type: array
          title: Disallowed Options
          description: option_ids to disqualify
      additionalProperties: false
      type: object
      required:
        - qualification_id
      title: PublicTargetingAttribute
      description: >-
        Target the panel by a qualification's answer options. Option-id rules:

        - both lists empty → allow all options;

        - only allowed → disqualify any option not listed;

        - only disallowed → allow any option not listed (can't disallow them
        all);

        - both → allowed are kept, disallowed are disqualified, and together
        they
          must cover every option_id of the qualification.
        Look up qualification_id / option_id via GET /targeting-attributes.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    PublicScreenerOption:
      properties:
        id:
          type: string
          title: Id
        text:
          type: string
          title: Text
        disqualify:
          type: boolean
          title: Disqualify
      type: object
      required:
        - id
        - text
        - disqualify
      title: PublicScreenerOption
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with an API key (prefixed `ui_sk_`) or a JWT token from the
        dashboard.

````