Share Appointment

Esta mutación permite generar un enlace único de acceso compartido para una cita específica. Adicionalmente, expone un parámetro de seguridad ajustable que permite condicionar el acceso de terceros mediante un código PIN dinámico generado por el sistema.

Detalles de la Solicitud

• Método HTTP: POST

• URL PRE: https://api.ovac.pre.councilbox.com/graphql

• URL PRO: https://api.ovac.councilbox.com/graphql

Autenticación

Tipo: API Key**
Header:** x-jwt-token
Ubicación: Header HTTP_
Ejemplo:_ x-jwt-token: eyJhbGciOiJIUzI1NiIsInR5cCI6...

Referencia de la API

Parámetros de Entrada (Variables)

Campos de Respuesta (Payload)

La mutación devuelve un objeto shareAppointment con el enlace securizado:

Ejemplos de Código y Peticiones

1. Mutación GraphQL

mutation ShareAppointment($councilId: ID!, $requirePin: Int) {
    shareAppointment(councilId: $councilId, requirePin: $requirePin) {
        url
        pin
    }
}

2. Variables de la Petición (JSON Payload)

{
    "councilId": 64767,
    "requirePin": 1
}

3. Ejemplo de comando cURL

curl --location "https://api.ovac.pre.councilbox.com/graphql" \
--header "Content-Type: application/json" \
--header "x-jwt-token: {{token}}" \
--data '{"query":"mutation ShareAppointment ($councilId: ID!, $requirePin: Int){ shareAppointment(councilId: $councilId, requirePin: $requirePin) { url pin } }","variables":{"councilId":64767,"requirePin":1}}'

4. Respuesta Esperada (200 OK)

{
    "data": {
        "shareAppointment": {
            "url": "https://l.councilbox.com/to/82e520fb",
            "pin": 18065
        }
    }
}

Nota OpenAPI/Fern: esta operación GraphQL se documenta como /graphql/shareappointment para que Fern pueda mostrarla como operación independiente. La ruta técnica real de ejecución es POST /graphql.