post
https://api-sandbox.urbanpayx.com/api/v1/contracts/templates//refresh
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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
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.writepermission 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 refreshedContractTemplateVersionResponse. Theroles,fields, anddetected_variablesreflect the latest metadata pulled from the signing provider, alongside the template'sid,name,status,file_type,external_id,signing_template_id,signing_template_slug,source_file,published_at, andcreated_at/updated_attimestamps.
Error responses
| Status | When |
|---|---|
400 | The template has not been provisioned for signing |
403 | Contract signing is disabled for this client |
404 | No template version with this ID exists under your client |
502 | The signing provider could not be reached or returned an error while fetching the latest template metadata |
503 | The 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.