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

# Enroll



## OpenAPI

````yaml /openapi.json post /v1/organizations/{organization_id}/apps/{app_id}/environments/{environment_id}/enrollments
openapi: 3.1.0
info:
  description: Are we on the same page?
  title: Synapse
  version: 0.1.0
servers: []
security: []
paths:
  /v1/organizations/{organization_id}/apps/{app_id}/environments/{environment_id}/enrollments:
    post:
      tags:
        - v1-platform
      summary: Enroll
      operationId: >-
        enroll_v1_organizations__organization_id__apps__app_id__environments__environment_id__enrollments_post
      parameters:
        - in: path
          name: organization_id
          required: true
          schema:
            format: uuid
            title: Organization Id
            type: string
        - in: path
          name: app_id
          required: true
          schema:
            format: uuid
            title: App Id
            type: string
        - in: path
          name: environment_id
          required: true
          schema:
            format: uuid
            title: Environment Id
            type: string
        - in: header
          name: Idempotency-Key
          required: true
          schema:
            maxLength: 255
            minLength: 1
            title: Idempotency-Key
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrollmentCreate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Enrollment'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Authentication required
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Insufficient scope
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Resource not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: State or idempotency conflict
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Request validation failed
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Internal server error
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
        - SessionCookie: []
components:
  schemas:
    EnrollmentCreate:
      additionalProperties: false
      properties:
        program_id:
          format: uuid
          title: Program Id
          type: string
        subject_id:
          format: uuid
          title: Subject Id
          type: string
      required:
        - subject_id
        - program_id
      title: EnrollmentCreate
      type: object
    Enrollment:
      properties:
        cycle_count:
          title: Cycle Count
          type: integer
        enrolled_at:
          format: date-time
          title: Enrolled At
          type: string
        environment_id:
          format: uuid
          title: Environment Id
          type: string
        id:
          format: uuid
          title: Id
          type: string
        last_cycle_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Last Cycle At
        next_due_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Next Due At
        program_id:
          format: uuid
          title: Program Id
          type: string
        status:
          enum:
            - active
            - paused
            - completed
            - withdrawn
          title: Status
          type: string
        subject_id:
          format: uuid
          title: Subject Id
          type: string
        withdrawn_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Withdrawn At
      required:
        - id
        - environment_id
        - subject_id
        - program_id
        - status
        - enrolled_at
        - cycle_count
      title: Enrollment
      type: object
    ApiErrorResponse:
      additionalProperties: false
      properties:
        detail:
          anyOf:
            - $ref: '#/components/schemas/ErrorDetail'
            - type: string
            - items: {}
              type: array
            - additionalProperties: true
              type: object
          title: Detail
      required:
        - detail
      title: ApiErrorResponse
      type: object
    ErrorDetail:
      additionalProperties: false
      description: Stable structured detail returned by versioned API errors.
      properties:
        code:
          title: Code
          type: string
        context:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Context
        message:
          title: Message
          type: string
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
      required:
        - code
        - message
      title: ErrorDetail
      type: object
  securitySchemes:
    BearerAuth:
      description: Named syn_ API key or migration-only legacy key.
      scheme: bearer
      type: http
    ApiKeyAuth:
      description: Header alias for a named or legacy API key.
      in: header
      name: X-API-Key
      type: apiKey
    SessionCookie:
      description: Opaque administrator browser session.
      in: cookie
      name: synapse_session
      type: apiKey

````