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

# Archiva un protocolo

> Requiere rol integrator o admin. Devuelve 409 si hay inscripciones activas.



## OpenAPI

````yaml /openapi/openapi-olivia.yaml delete /v1/protocols/{idOrKey}
openapi: 3.1.0
info:
  title: OlivIA API
  version: 0.1.0
  description: >
    API externa de OlivIA, la plataforma de seguimiento clínico por voz de
    Omniloy. Permite a un sistema externo (EHR/HIS, CRM o backend propio):

    - Seguimiento (llamadas salientes): inscribir pacientes en un protocolo para
    que OlivIA los llame y complete un cuestionario.

    - Triaje (llamadas entrantes): los resultados de las llamadas de triaje se
    consultan por estos mismos endpoints de lectura.

    - Lectura de resultados: cuestionarios (protocol runs), respuestas, score,
    llamadas, transcripción y grabación.

    Autenticación por API key personal como bearer token (`Authorization: Bearer
    oc_sk_...`). Todas las rutas cuelgan del prefijo `/v1` y las respuestas
    envuelven el contenido en `data`.
servers:
  - url: https://{your-prod-endpoint}
    description: Producción
    variables:
      your-prod-endpoint:
        default: your-prod-endpoint
        description: Sustituye este valor por el host real antes de probar la petición.
  - url: https://{your-dev-endpoint}
    description: Staging
    variables:
      your-dev-endpoint:
        default: your-dev-endpoint
        description: Sustituye este valor por el host de staging.
security:
  - bearerAuth: []
tags:
  - name: Protocolos
    description: Consulta y archivado de protocolos.
  - name: Inscripciones
    description: Inscribir pacientes y consultar inscripciones (seguimiento saliente).
  - name: Cuestionarios
    description: Ejecuciones de protocolo (protocol runs) y sus resultados.
  - name: Llamadas
    description: Detalle de llamadas, transcripción y grabación.
paths:
  /v1/protocols/{idOrKey}:
    delete:
      tags:
        - Protocolos
      summary: Archiva un protocolo
      description: >-
        Requiere rol integrator o admin. Devuelve 409 si hay inscripciones
        activas.
      operationId: delete-protocol
      parameters:
        - name: idOrKey
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Protocolo archivado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtocolResponse'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
components:
  schemas:
    ProtocolResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Protocol'
    Protocol:
      type: object
      properties:
        id:
          type: string
          format: uuid
        org_id:
          type: string
          format: uuid
        protocol_key:
          type: string
        title:
          type: string
        description:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - draft
            - active
            - archived
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
  responses:
    Forbidden:
      description: La key no tiene el rol necesario
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Conflict:
      description: Conflicto de estado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: oc_sk_ API key

````