Making a Template Version Live
API Version: v2.0
Method: PATCH
Endpoint: /TemplatePackages/{templatePackageId}/Versions/{versionId}
The live from date API method allows you to update the liveFromDate of a specific version of a template package. This is useful for managing when a template version becomes available to users in HotDocs Advance.
Prerequisites
Before making a 'live from date' request, you must have an access token to sign the request. You can retrieve an access token using one of the following flows:
- Getting an access token using the Resource Owner flow
- Getting an access token using the Implicit flow
Overview
You can use this endpoint to:
- make a version live immediately by providing the current UTC timestamp or a timestamp in the past.
- schedule a version to go live in the future by providing a future UTC timestamp.
Only the most recent version of a template package can be scheduled to go live. If a newer version is uploaded after a future liveFromDate is set, the scheduled activation will be overridden, and the older version will not become live.
This is a command method and requires the API client to have either a command or a root scope.
Authentication
See Authentication for more information about authenticating requests to the Advance API.
API Documentation
You can view the latest reference documentation for the Advance API at https://yourorganization.com/HdaApi/rest/documentation/index.html, where yourorganization.com is the domain under which your Advance deployment is located.
Request
Request URL
PATCH https://{tenancymoniker}.{domain}/HdaApi/rest/v2.0/TemplatePackages/{templatePackageId}/Versions/{versionId}
Headers
| Key | Required | Description | Example value |
| Authorization | Yes | The Authorization header for the request. Uses the access token retrieved (see Prerequisites section above for more information). | Bearer [access token] |
Parameters
| Name | Type | Location | Required | Description |
| tenancymoniker | String | URL | Yes | The tenancy moniker for the tenancy in which you want to create the new work item. |
| domain | String | URL | Yes | Your domain. For example, yourorganization.com. |
| templatePackageId | Guid | URL | Yes | The ID of the template package version. |
| liveFromDate | String | Request body | Yes | The date and time from which the template package version is live. This must be specified in ISO 8601 format and UTC. |
Examples
Example Request URL
https://yourtenancy.yourorganization.com/HdaApi/rest/v2.0/TemplatePackages/4a404239-527c-4470-b53f-7cc7f46445bd/Version/3f2504e0-4f89-11d3-9a0c-0305e82c3301
Example Request JSON
{
"liveFromDate": "2020-01-22T16:56:57.687Z",
}
Example Response
Status: 204v2.0