> ## 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.

# Patch Participant

> Update email, customer ID, or bounded metadata.



## OpenAPI

````yaml /api-reference/openapi.json patch /api/public/v1/participants/{participant_id}
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/participants/{participant_id}:
    patch:
      tags:
        - public-participants
      summary: Patch Participant
      description: Update email, customer ID, or bounded metadata.
      operationId: updateParticipant
      parameters:
        - name: participant_id
          in: path
          required: true
          schema:
            type: string
            title: Participant Id
          example: 66666666-7777-8888-9999-000000000000
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicParticipantPatch'
            examples:
              Update email:
                summary: Update participant email
                description: >-
                  The participant ID is supplied in the path; email is the only
                  mutable body field.
                value:
                  email: alex.new@example.com
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicParticipant'
        '422':
          description: Public API error. X-Request-ID matches error.request_id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
        default:
          description: Public API error. X-Request-ID matches error.request_id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
components:
  schemas:
    PublicParticipantPatch:
      properties:
        email:
          anyOf:
            - type: string
              format: email
            - type: 'null'
          title: Email
          description: New email, or null to clear the email
        external_id:
          anyOf:
            - type: string
              maxLength: 128
              minLength: 1
            - type: 'null'
          title: External Id
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
      additionalProperties: false
      type: object
      title: PublicParticipantPatch
    PublicParticipant:
      properties:
        external_id:
          anyOf:
            - type: string
              maxLength: 128
              minLength: 1
            - type: 'null'
          title: External Id
          description: Customer ID, unique among active BYOP invitations in this study
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
          description: Up to 20 scalar CRM fields and 4 KiB total
        id:
          type: string
          title: Id
        study_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Study Id
          description: The study this participant belongs to
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        interview_link:
          anyOf:
            - type: string
            - type: 'null'
          title: Interview Link
          description: >-
            Personal interview link for this invitation; usable when the study
            is provisioned and active
        status:
          type: string
          enum:
            - created
            - invited
            - started
            - completed
            - screened_out
          title: Status
          description: >-
            Invitation and interview progress; created means no invitation email
            was sent
        interview_count:
          type: integer
          title: Interview Count
          description: >-
            Visible non-test interview sessions for this invitation, not unique
            people
          default: 0
        reward_sent:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Reward Sent
        reward_sent_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Reward Sent At
        invite_sent_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Invite Sent At
          description: When this participant's invitation email was sent
        invite_created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Invite Created At
          description: When this participant invitation was created
      type: object
      required:
        - id
        - status
      title: PublicParticipant
      description: |-
        A BYOP invitation/participation record, not a deduplicated person.

        Panel recruiting is represented by the panel endpoints, not by synthetic
        participant records on this resource.
    PublicApiErrorResponse:
      type: object
      required:
        - detail
        - error
      properties:
        detail:
          description: Legacy error detail; may be a string, list, or object.
        error:
          $ref: '#/components/schemas/PublicApiError'
    PublicApiError:
      type: object
      required:
        - code
        - message
        - field
        - request_id
        - outcome
        - recovery_action
        - docs_url
      properties:
        code:
          type: string
        message:
          type: string
        field:
          anyOf:
            - type: string
            - type: 'null'
        request_id:
          type: string
          format: uuid
        outcome:
          type: string
          enum:
            - not_started
            - failed
            - unknown
        recovery_action:
          type: string
        docs_url:
          type: string
          format: uri
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate with an API key (prefixed `ui_sk_`) or a JWT token from the
        dashboard.

````