> ## Documentation Index
> Fetch the complete documentation index at: https://mixpanel-edb78807-coltonblake-demo-generated-openapi.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Example

> Example description



## OpenAPI

````yaml openapi/platform.openapi.json POST /v1/example/
openapi: 3.1.0
info:
  title: Mixpanel Platform API
  version: '1'
  description: ''
servers:
  - url: https://platform-{region}.mixpanel.com
    variables:
      region:
        default: us
        enum:
          - us
          - eu
          - in
        description: Mixpanel data residency region.
security: []
paths:
  /v1/example/:
    post:
      tags:
        - Example
      summary: Example
      description: Example description
      operationId: v1_example_api_example
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExampleRequest'
        required: true
      responses:
        '204':
          description: No Content
        '422':
          description: Request validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestValidationErrorResponse'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ExampleRequest:
      properties:
        sub_id:
          $ref: '#/components/schemas/SubId'
      required:
        - sub_id
      title: ExampleRequest
      type: object
    RequestValidationErrorResponse:
      additionalProperties: false
      properties:
        type:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: A stable reference that identifies the problem type, if applicable.
          title: ''
        status:
          description: >-
            The HTTP status code generated by the origin server for this
            occurrence of the problem.
          title: ''
          type: integer
        instance:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            A stable reference that identifies the specific occurrence of the
            problem, if applicable.
          title: ''
        detail:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem, if applicable.
          title: ''
        error_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Opaque identifier for this error occurrence. Include it when
            contacting support so the corresponding server-side error can be
            located.
          title: ''
        errors:
          anyOf:
            - items:
                anyOf:
                  - $ref: '#/components/schemas/RequestValidationErrorItem'
                  - additionalProperties: true
                    type: object
              type: array
            - type: 'null'
          default: null
          description: The set of request validation errors.
          title: ''
        title:
          description: A short, human-readable summary of the problem type.
          readOnly: true
          title: ''
          type: string
      required:
        - status
        - title
      title: RequestValidationErrorResponse
      type: object
    ErrorResponse:
      additionalProperties: false
      properties:
        type:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: A stable reference that identifies the problem type, if applicable.
          title: ''
        status:
          description: >-
            The HTTP status code generated by the origin server for this
            occurrence of the problem.
          title: ''
          type: integer
        instance:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            A stable reference that identifies the specific occurrence of the
            problem, if applicable.
          title: ''
        detail:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem, if applicable.
          title: ''
        error_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Opaque identifier for this error occurrence. Include it when
            contacting support so the corresponding server-side error can be
            located.
          title: ''
        title:
          description: A short, human-readable summary of the problem type.
          readOnly: true
          title: ''
          type: string
      required:
        - status
        - title
      title: ErrorResponse
      type: object
    SubId:
      properties:
        format:
          const: email
          title: Format
          type: string
        email:
          title: Email
          type: string
      required:
        - format
        - email
      title: SubId
      type: object
    RequestValidationErrorItem:
      properties:
        type:
          description: Machine-readable validation error type, e.g. 'missing'.
          title: Type
          type: string
        loc:
          description: Location of the offending value in the request.
          items:
            anyOf:
              - type: string
              - type: integer
          title: Loc
          type: array
        msg:
          description: Human-readable description of the error.
          title: Msg
          type: string
        ctx:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          default: null
          description: Additional context about the error, if any.
          title: Ctx
      required:
        - type
        - loc
        - msg
      title: RequestValidationErrorItem
      type: object

````