Update Adhesions
PATCH
/adhesionsModifica una adhesión existente de agenda.
Objetivo
Este endpoint permite actualizar el estado de una adhesión (por ejemplo, desactivarla) o modificar parámetros como el alias.
Request
Headers
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
x-api-key | String | Sí | API Key provista para acceder al endpoint. |
x-authorization-token | String | Sí | Token de autenticación generado en el login. |
Body Parameters
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
agendaId | String | Sí | Identificador único de la adhesión a modificar. |
alias | String | No | Nuevo alias para la adhesión. |
isAdhered | Boolean | No | Estado de la adhesión (true para activar, false para desactivar). |
isAutomaticDebit | Boolean | No | Configuración de débito automático. |
externalClientId | String | Sí | Identificador único del cliente externo. |
Response
Response Body
| Parámetro | Tipo | Descripción |
|---|---|---|
serviceIdentifier | String | Identificador del servicio según el proveedor. |
modalityId | UUID | Identificador de la modalidad utilizada en la consulta. |
companyCode | String | Código de empresa TAPI. |
alias | String | Identificador personalizado del usuario final. |
type | String | Tipo de novedad de agenda que genera. |
agendaId | String | Identificador de adhesión de agenda. |
isAutomaticDebit | Boolean | Indicador de adhesión en débito automático. |
isAdhered | Boolean | Indica si la adhesión está activa. |
tx | UUID | Identificador del paso en la transacción solicitada. |
mainTx | UUID | Identificador de la transacción solicitada. |
Response Examples
200 OK
Consideraciones
- Para desactivar una adhesión, enviar el campo 'isAdhered' en false.
- El identificador agendaId es clave para referenciar la adhesión a modificar.
- Solo se pueden modificar los campos enviados en el body, el resto permanecen sin cambios.
CLIENT LIBRARIES
REQUEST EXAMPLE
curl --request PATCH \
--url https://agenda.homo.tapila.cloud/adhesions \
--header 'x-authorization-token: YOUR_TOKEN_HERE' \
--header 'x-api-key: YOUR_API_KEY_HERE' \
--header 'Content-Type: application/json' \
--data '{
"agendaId": "",
"alias": "",
"isAdhered": true,
"isAutomaticDebit": false,
"externalClientId": ""
}'