Skip to navigation

Crear una plantilla de contrato

Una plantilla que el cliente firma. body es HTML con variables que se llenan al enviar: {nombre}, {comercio}, {servicio}, {fecha} y las demás que muestra el editor. fields son los datos que el cliente llena al firmar. Con service_ids, esos servicios la envían con cada cita; signature_required_before dice cuándo debe estar firmada.

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.

Request

This endpoint expects an object.
namestringOptional<=80 characters
bodystringOptional
HTML con variables.
signature_required_beforeenumOptional
Allowed values:
signature_valid_for_monthsinteger or nullOptional1-60
fieldslist of objectsOptional

La lista completa de lo que el cliente llena (máximo 15).

service_idslist of stringsOptional

Response

Plantilla creada
idstring or nullOptional

null en un borrador del modelo, que aún no se guarda.

namestringOptional
bodystringOptional

HTML con variables ({nombre}, {comercio}, {servicio}…) que se llenan al enviar.

signature_required_beforeenumOptional

Con una cita: firmar antes de confirmarla, antes de la visita, o no exige firma (informativa).

Allowed values:
signature_valid_for_monthsinteger or nullOptional

Cuántos meses cubre una firma al mismo cliente; null, cada cita pide otra.

fieldslist of objectsOptional
service_idslist of stringsOptional

Los servicios que la envían con cada cita.

created_atdatetime or nullOptional

Errors

422
Unprocessable Entity Error