Skip to navigation

Recordar un contrato

Manda ahora el único recordatorio de un contrato que espera firma, en vez de esperar las 48 horas. En un Sandbox lo registra sin enviar nada.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Path parameters

contract_idstringRequired

Response

Recordatorio enviado
idstringOptional
account_idstringOptional
template_idstringOptional
customerobjectOptional
booking_idstring or nullOptional

La cita que lo pidió, si vino de una.

checkout_idstring or nullOptional

El cobro que se paga después de firmar.

checkout_urlstring or nullOptional
titlestringOptional
statusenumOptional
Allowed values:
sent_viaenum or nullOptional
Allowed values:
signing_urlstringOptional

La página donde el cliente lee y firma (link firmado).

field_valuesobjectOptional

Lo que el cliente llenó al firmar, por key del campo.

verified_channelenum or nullOptional

Por dónde confirmó su identidad con un código antes de firmar.

Allowed values:
body_sha256string or nullOptional

SHA-256 del texto firmado.

pdf_availablebooleanOptional
Si ya se puede descargar el PDF firmado.
viewed_atdatetime or nullOptional
signed_atdatetime or nullOptional
valid_untildatetime or nullOptional
declined_atdatetime or nullOptional
decline_reasonstring or nullOptional
reminder_sent_atdatetime or nullOptional
created_atdatetimeOptional

Errors

422
Unprocessable Entity Error