Skip to main content

​
Endpoints

MethodPathDescription
GET/v1/contract-templatesList contract templates (optionally filtered by locale or type).
POST/v1/contract-templatesCreate a contract template.
GET/v1/contract-templates/:idRetrieve a contract template (supports locale override).
PUT/v1/contract-templates/:idUpdate template metadata, JSON payload, or translations.
DELETE/v1/contract-templates/:idDelete a contract template.
Read operations require the contract-templates:read scope. Mutations require contract-templates:write.

​
Key concepts

  • Templates store a structured templateJson payload with sections and merge variables consumed by PDF and e-sign workflows.
  • type distinguishes customer, supplier, and partner contract variants; omit it for all-purpose templates.
  • Optional translation blocks let you attach localized metadata and HTML bodies—fetch with locale (or lang) query parameters.
  • Webhook events (contract-template.created|updated|deleted) fire on changes for downstream sync.
  • Template variables can be documented inside translation.variables to help consumer apps populate dynamic data.