Cancel Appointment | Councilbox OVAC API

Este método permite cancelar una cita existente en el sistema identificándola a través de su councilId. Opcionalmente, permite notificar al participante e incluir un mensaje con el motivo de la cancelación.

Detalles de la Solicitud

Método HTTP: POST
URL PRE: https://api.ovac.pre.councilbox.com/graphql
URL PRO: https://api.ovac.pre.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)

Campo	Tipo	Requerido	Descripción
councilId	Integer	Sí	Identificador único de la cita que se desea cancelar.
notify	Boolean	Sí	Indica si se debe enviar una notificación automática de cancelación al participante (`true`/`false`).
message	String	No	Texto informativo o descripción con el motivo del desestimiento.
reason	String	No	A continuación se describen los motivos de cancelación: ‘`unavailable`’ -> Participante no disponible ‘`not_interested`’ -> Participante no interesado ‘`procedure_already_completed`’ -> Procedimiento ya realizado ‘`incorrect_data`’ -> Datos incorrectos ‘`difficult_access`’ -> Dificultad en el acceso ‘`incompatible_browser`’ -> Navegador incompatible ‘`others`’ -> Otros motivos

Campos de Respuesta (Payload)

Al ejecutar la mutación, el sistema devolverá un objeto cancelAppointment con los siguientes campos funcionales:

Campo	Tipo	Descripción
success	Boolean	Devuelve `true` si la cancelación se procesó correctamente; `false` en caso contrario.
message	String	Mensaje informativo del sistema o detalle del error. Puede devolver `null` si la operación es limpia.

Ejemplos de Código y Peticiones

1. Mutación GraphQL

1 mutation CancelAppointment($councilId: Int!, $notify: Boolean!, $message: String) {
2     cancelAppointment(councilId: $councilId, notify: $notify, message: $message) {
3         success
4         message
5     }
6 }

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

1 {
2     "councilId": 64683,
3     "notify": true,
4     "message": "MOTIVO CANCELACION"
5 }

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 CancelAppointment($councilId: Int!, $notify: Boolean!, $message: String){\n    cancelAppointment(councilId: $councilId, notify:$notify, message: $message){\n        success\n        message\n    }\n}\n","variables":{"councilId":64683,"notify":true,"message":"MOTIVO CANCELACION"}}'

4. Respuesta Esperada (200 OK)

1 {
2     "data": {
3         "cancelAppointment": {
4             "success": true,
5             "message": null
6         }
7     }
8 }

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

# Cancel Appointment (`mutation`) Este método permite cancelar una cita existente en el sistema identificándola a través de su `councilId`. Opcionalmente, permite notificar al participante e incluir un mensaje con el motivo de la cancelación. ### Detalles de la Solicitud - **Método HTTP:** `POST` - **URL PRE:** `https://api.ovac.pre.councilbox.com/graphql` - **URL PRO:** `https://api.ovac.pre.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) | **Campo** | **Tipo** | **Requerido** | **Descripción** | | --- | --- | --- | --- | | **councilId** | Integer | Sí | Identificador único de la cita que se desea cancelar. | | **notify** | Boolean | Sí | Indica si se debe enviar una notificación automática de cancelación al participante (`true`/`false`). | | **message** | String | No | Texto informativo o descripción con el motivo del desestimiento. | | **reason** | String | No | A continuación se describen los motivos de cancelación: '`unavailable`' -> Participante no disponible '`not_interested`' -> Participante no interesado '`procedure_already_completed`' -> Procedimiento ya realizado '`incorrect_data`' -> Datos incorrectos '`difficult_access`' -> Dificultad en el acceso '`incompatible_browser`' -> Navegador incompatible '`others`' -> Otros motivos | ### Campos de Respuesta (Payload) Al ejecutar la mutación, el sistema devolverá un objeto `cancelAppointment` con los siguientes campos funcionales: | **Campo** | **Tipo** | **Descripción** | | --- | --- | --- | | **success** | Boolean | Devuelve `true` si la cancelación se procesó correctamente; `false` en caso contrario. | | **message** | String | Mensaje informativo del sistema o detalle del error. Puede devolver `null` si la operación es limpia. | ## Ejemplos de Código y Peticiones ### 1\. Mutación GraphQL ``` graphql mutation CancelAppointment($councilId: Int!, $notify: Boolean!, $message: String) { cancelAppointment(councilId: $councilId, notify: $notify, message: $message) { success message } } ``` ### 2\. Variables de la Petición (JSON Payload) ``` json { "councilId": 64683, "notify": true, "message": "MOTIVO CANCELACION" } ``` ### 3\. Ejemplo de comando cURL ``` bash curl --location 'https://api.ovac.pre.councilbox.com/graphql' \ --header 'Content-Type: application/json' \ --header 'x-jwt-token: {{token}}' \ --data '{"query":"mutation CancelAppointment($councilId: Int!, $notify: Boolean!, $message: String){\n cancelAppointment(councilId: $councilId, notify:$notify, message: $message){\n success\n message\n }\n}\n","variables":{"councilId":64683,"notify":true,"message":"MOTIVO CANCELACION"}}' ``` ### 4\. Respuesta Esperada (200 OK) ``` json { "data": { "cancelAppointment": { "success": true, "message": null } } } ``` > **Nota OpenAPI/Fern:** esta operación GraphQL se documenta como `/graphql/cancelappointment` para que Fern pueda mostrarla como operación independiente. La ruta técnica real de ejecución es `POST /graphql`.

Authentication

x-jwt-tokenstring

JWT token obtained from Login.

Request

This endpoint expects an object.

querystringRequired

GraphQL operation

variablesobjectOptional

GraphQL variables

Response

Successful response. GraphQL business errors may be returned inside the JSON errors field while transport status remains HTTP 200.