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

# Stop this evaluation, retaining answers, tickets, plans and other participations



## OpenAPI

````yaml /openapi-v1.json post /v1/journeys/{id}/enrollments/{enrollmentId}/stop
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/{enrollmentId}/stop:
    post:
      tags:
        - v1 - journeys
      summary: >-
        Stop this evaluation, retaining answers, tickets, plans and other
        participations
      operationId: V1JourneysController_stopParticipation
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
        - name: enrollmentId
          required: true
          in: path
          schema:
            type: string
        - 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/StopJourneyParticipationDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1JourneyParticipationDto'
        '400':
          description: Invalid identifier or journey configuration
          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
        '422':
          description: Idempotency key reused for a different operation
      security:
        - bearer: []
components:
  schemas:
    StopJourneyParticipationDto:
      type: object
      properties:
        reason:
          type: string
          maxLength: 280
    V1JourneyParticipationDto:
      type: object
      properties:
        id:
          type: string
        subjectKey:
          type: string
        contact:
          $ref: '#/components/schemas/V1JourneyContactDto'
        lifecycle:
          type: string
          enum:
            - pending
            - running
            - stopping
            - stopped
            - completed
        definitionVersion:
          type: number
        startedAt:
          type: string
          format: date-time
        startSource:
          type: string
          enum:
            - operator
            - response
            - webhook
        stoppedAt:
          type: string
          format: date-time
        completedAt:
          type: string
          format: date-time
        stopRequestedAt:
          type: string
          format: date-time
        stoppedBy:
          type: string
        stopReason:
          type: string
        dispatchOutcomeUncertain:
          type: boolean
        createdAt:
          type: string
          format: date-time
        pendingMoments:
          type: array
          items:
            $ref: '#/components/schemas/V1JourneyPendingMomentDto'
        moments:
          type: array
          items:
            $ref: '#/components/schemas/V1JourneyMomentProgressDto'
        next:
          type: object
          nullable: true
          properties:
            stageKey:
              type: string
            name:
              type: string
            source:
              type: string
              enum:
                - operator
                - response
                - webhook
                - timer
                - fallback
            scheduledFor:
              type: string
              format: date-time
          required:
            - stageKey
            - name
            - source
      required:
        - id
        - subjectKey
        - contact
        - lifecycle
        - dispatchOutcomeUncertain
        - pendingMoments
        - moments
        - next
    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'
    V1JourneyPendingMomentDto:
      type: object
      properties:
        key:
          type: string
        name:
          type: string
      required:
        - key
    V1JourneyMomentProgressDto:
      type: object
      properties:
        key:
          type: string
        name:
          type: string
        status:
          type: string
          enum:
            - pending
            - active
            - sent
            - responded
            - done
            - skipped
        toolId:
          type: string
        toolType:
          type: string
          enum:
            - woku
            - csat
            - ces
            - nps
            - flow
            - form
        toolScope:
          type: string
          enum:
            - shared
            - per_enrollment
        sentAt:
          type: string
          format: date-time
        respondedAt:
          type: string
          format: date-time
        activationSource:
          type: string
          enum:
            - operator
            - response
            - webhook
            - timer
            - fallback
        hookReceivedAt:
          type: string
          format: date-time
      required:
        - key
        - name
        - status
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: Company secret API key.

````