Refresh Contract Template

Refresh contract template metadata

Pulls the latest signer roles and fields from the signing provider so
edits made in the document builder become visible to workflows.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Re-syncs a contract template version with the signing provider. The endpoint pulls the latest signer roles and fields from the document builder, refreshes the detected variable placeholders, persists the updated metadata, and returns the refreshed template version. Use it after editing a template in the embedded document builder so the changes become visible to your workflows.

Authentication & access

  • Requires a client API token: Authorization: Bearer <token>.
  • The caller must hold the contracts.templates.write permission and have the OWNER, OPERATIONS, or DEVELOPER role.
  • The client must have contract signing enabled. If the feature is disabled the request returns 403.

Path parameters

  • template_version_id (string, required) — the template version to refresh. It must belong to your client.

Preconditions

  • The template version must exist under your client, otherwise the request returns 404.
  • The template must already be provisioned for signing. A template that has not yet been provisioned with the signing provider is rejected with 400.

Response

  • 200 — Returns the refreshed ContractTemplateVersionResponse. The roles, fields, and detected_variables reflect the latest metadata pulled from the signing provider, alongside the template's id, name, status, file_type, external_id, signing_template_id, signing_template_slug, source_file, published_at, and created_at / updated_at timestamps.

Error responses

StatusWhen
400The template has not been provisioned for signing
403Contract signing is disabled for this client
404No template version with this ID exists under your client
502The signing provider could not be reached or returned an error while fetching the latest template metadata
503The signing provider is temporarily unavailable; retry later

Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.

Path Params
string
required
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json