Cancel Appointment_External | Councilbox OVAC API

# Cancel Appointment (`mutation`) Este método permite cancelar una cita existente en el sistema identificándola a través de su `councilId`. La operación admite la posibilidad de notificar de forma automática al participante sobre la revocación de la cita mediante el parámetro `notify`, así como incluir un texto descriptivo con el motivo de la cancelación a través del campo `message`. ### 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) | Parámetro | Descripción | Requerido | Tipo | | --- | --- | --- | --- | | councilId | Id de la cita que se desea cancelar. | SI | Integer | | notify | Campo para activar o desactivar el aviso de cancelación de la cita al participante. | SI | Boolean | | message | Mensaje con el motivo de cancelación de la cita. | NO | String | > StartFragment⚠️ **Nota de Depuración:** En ejemplos de integración antiguos figuraba el campo `reason` dentro de las variables. Este parámetro no forma parte de la firma de la mutación `cancelAppointment` y el backend lo ignorará por completo. Se recomienda eliminarlo de los payloads activos.EndFragment ### Campos de Respuesta (Payload) La operación devuelve un resultado funcional simple bajo el objeto `cancelAppointment`: | **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){ cancelAppointment(councilId: $councilId, notify:$notify, message: $message){ success message } }","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-2` para que Fern pueda mostrarla como operación independiente. La ruta técnica real de ejecución es `POST /graphql`.

Este método permite cancelar una cita existente en el sistema identificándola a través de su councilId. La operación admite la posibilidad de notificar de forma automática al participante sobre la revocación de la cita mediante el parámetro notify, así como incluir un texto descriptivo con el motivo de la cancelación a través del campo message.

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)

Parámetro	Descripción	Requerido	Tipo
councilId	Id de la cita que se desea cancelar.	SI	Integer
notify	Campo para activar o desactivar el aviso de cancelación de la cita al participante.	SI	Boolean
message	Mensaje con el motivo de cancelación de la cita.	NO	String

StartFragment⚠️ Nota de Depuración: En ejemplos de integración antiguos figuraba el campo reason dentro de las variables. Este parámetro no forma parte de la firma de la mutación cancelAppointment y el backend lo ignorará por completo. Se recomienda eliminarlo de los payloads activos.EndFragment

Campos de Respuesta (Payload)

La operación devuelve un resultado funcional simple bajo el objeto cancelAppointment:

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){ cancelAppointment(councilId: $councilId, notify:$notify, message: $message){ success message } }","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-2 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.