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

# Enroll a subject in this journey

> Starts an operator-led v2 participation without requiring its first answer. A v2 contact can have one unfinished participation per journey. The same subjectKey can start a new cycle after completion or stopping finishes; each cycle has a distinct enrollment id. Legacy definitions retain their enrollment behavior.



## OpenAPI

````yaml /openapi-v1.json post /v1/journeys/{id}/enrollments
openapi: 3.0.0
info:
  title: Woku Client API v1
  description: >-
    Public REST API for programmatic management of woku Voice-of-Customer
    programs: trackers, VoC instruments (NPS, woku, CES, CSAT), action plans,
    support tickets, multi-channel sending and response capture. Requests are
    company-scoped by the API key; never send a company id.
  version: 1.0.0
  contact:
    name: Woku
    url: https://woku.app
    email: team@woku.app
servers:
  - url: https://clientapi.woku.app
    description: Production
security: []
tags: []
paths:
  /v1/journeys/{id}/enrollments:
    post:
      tags:
        - v1 - journeys
      summary: Enroll a subject in this journey
      description: >-
        Starts an operator-led v2 participation without requiring its first
        answer. A v2 contact can have one unfinished participation per journey.
        The same subjectKey can start a new cycle after completion or stopping
        finishes; each cycle has a distinct enrollment id. Legacy definitions
        retain their enrollment behavior.
      operationId: V1JourneysController_enroll
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
            format: ObjectId
        - name: X-Woku-Idempotency-Key
          in: header
          description: >-
            Client-generated key to make the call safe to retry. A retry with
            the same key and operation returns the original result instead of
            acting again. Do not reuse it for new input: retries replay the
            original body. A different operation returns 422.
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1EnrollSubjectBodyDto'
      responses:
        '201':
          description: The subject was enrolled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1JourneyEnrollmentResponseDto'
        '400':
          description: Validation error, or the journey is switched off
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponseDto'
        '403':
          description: Invalid API key, company access or entitlement
        '404':
          description: Journey, moment or evaluation not found
        '409':
          description: The subject is already enrolled
        '422':
          description: Idempotency key reused for a different operation
      security:
        - bearer: []
components:
  schemas:
    V1EnrollSubjectBodyDto:
      type: object
      properties:
        authHeader:
          type: string
          deprecated: true
          writeOnly: true
          description: >-
            Legacy body API key. Prefer Authorization: Bearer. Consumed by
            authentication and never forwarded to journey commands.
        subjectKey:
          type: string
          description: 'Your own key for who is enrolled: a customer id, an order, a ticket.'
          example: cliente-123
        contact:
          description: Where to reach the subject. At least one of email or phone.
          allOf:
            - $ref: '#/components/schemas/V1JourneyContactDto'
        trackers:
          type: array
          items:
            $ref: '#/components/schemas/V1JourneyTrackerDto'
        metadata:
          type: object
          description: Anything you want kept with it
          additionalProperties: true
      required:
        - subjectKey
        - contact
    V1JourneyEnrollmentResponseDto:
      type: object
      properties:
        subjectKey:
          type: string
        journeyId:
          type: string
      required:
        - subjectKey
        - journeyId
    ValidationErrorResponseDto:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 400
        message:
          description: Array of validation error messages
          example:
            - email must be a valid email
            - password must be at least 8 characters
          type: array
          items:
            type: string
        error:
          type: string
          description: Error type
          example: Bad Request
      required:
        - statusCode
        - message
        - error
    V1JourneyContactDto:
      type: object
      properties:
        email:
          type: string
          format: email
          example: cliente@example.com
        phone:
          type: string
          description: Phone with country code, digits only
          example: '56911111111'
    V1JourneyTrackerDto:
      type: object
      properties:
        name:
          type: string
          example: campaign
        value:
          type: string
          example: black-friday
      required:
        - name
        - value
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: Company secret API key.

````