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

# Save Tour Status

> Saves the completion state of a tour for the current user.
Idempotent — if a tour with the same `tour_key` exists, it is updated;
otherwise a new entry is created.




## OpenAPI

````yaml /api-reference/openapi/Evo-Auth-Service/user_tours.yaml post /api/v1/user_tours
openapi: 3.0.4
info:
  title: Evolution Foundation - Auth Service - User Tours
  description: |
    Tracks the completion state of in-app onboarding tours per user.
    Each tour is identified by a free-form `tour_key` chosen by the frontend.

    Available starting `v1.0.0-rc3`.
  version: 1.0.0
servers:
  - url: https://app.evochat.ai
  - url: http://localhost:3001
security: []
paths:
  /api/v1/user_tours:
    post:
      summary: Save Tour Status
      description: |
        Saves the completion state of a tour for the current user.
        Idempotent — if a tour with the same `tour_key` exists, it is updated;
        otherwise a new entry is created.
      operationId: save-user-tour
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - tour
              properties:
                tour:
                  type: object
                  required:
                    - tour_key
                  properties:
                    tour_key:
                      type: string
                      description: Free-form identifier for the tour
                      example: agents-walkthrough
                    completed_at:
                      type: string
                      format: date-time
                      description: When the tour was finished (defaults to now)
                    status:
                      type: string
                      enum:
                        - completed
                        - skipped
                        - in_progress
                      default: completed
                      description: >-
                        Tour completion state (unknown values fall back to
                        'completed')
      responses:
        '200':
          description: Tour saved
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/UserTour'
                  message:
                    type: string
                    example: Tour saved successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  schemas:
    UserTour:
      type: object
      properties:
        id:
          type: string
          format: uuid
        tour_key:
          type: string
          example: agents-walkthrough
        completed_at:
          type: string
          format: date-time
        status:
          type: string
          enum:
            - completed
            - skipped
            - in_progress
          example: completed
  responses:
    Unauthorized:
      description: Missing or invalid bearer token
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Unauthorized
    ValidationError:
      description: Validation failed
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
              errors:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.