Crear Adhesión

POST/adhesions/register

Crea una nueva adhesión de agenda para un usuario.

Objetivo

Permite registrar una adhesión a un servicio para un cliente, incluyendo parámetros de alias, modalidad y tipo de notificación.

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

Parámetro	Tipo	Requerido	Descripción
companyCode	String	Sí	Código de compañía.
modalityId	String	Sí	Id de la modalidad.
alias	String	Sí	Alias para referenciar a la adhesión.
queryData	Object	Sí	Objeto con el identificador de la factura.
externalClientId	String	Sí	Identificador único de cada usuario del cliente de tapi. Este es utilizado para el flujo de Recordatorios.

Response

Response Body

Parámetro	Tipo	Descripción
serviceIdentifier	String	Identificador del servicio (ej: número de cuenta, DNI).
modalityId	UUID	Identificador de la modalidad utilizada.
companyCode	String	Código de empresa de TAPI.
alias	String	Alias definido por el usuario.
type	String	Tipo de evento asociado (ej: EXPIRATION).
agendaId	String	Identificador de la adhesión generada.
isAutomaticDebit	Boolean	Define si la adhesión tiene débito automático.
isAdhered	Boolean	Indica si está activa la adhesión.
tx	UUID	ID de la transacción.
mainTx	UUID	ID principal de la transacción.

Response Examples

200 OK

Consideraciones

El campo 'serviceIdentifier' debe coincidir con un identificador válido para la empresa seleccionada.
El alias es opcional, pero recomendable para facilitar futuras referencias por parte del cliente.
El tipo de evento más común es 'EXPIRATION' para notificaciones de vencimiento.

CLIENT LIBRARIES

REQUEST EXAMPLE

curl --request POST \
--url https://agenda.homo.tapila.cloud/adhesions/register \
--header 'x-authorization-token: YOUR_TOKEN_HERE' \
--header 'x-api-key: YOUR_API_KEY_HERE' \
--header 'Content-Type: application/json' \
--data '{
  "companyCode": "",
  "modalityId": "",
  "alias": "",
  "queryData": {"identifierName":"","identifierValue":""},
  "externalClientId": ""
}'

Referencia API