Making a Template Version Live

The live from date API method enables you to set the date and time from which a template package version is made accessible to users. The template package version is automatically made live at the specified date and time.

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:

Overview

The 'live from date' API method is a command method. The API client invoking this method must have either a command or a root scope.

This method is useful when you want to upload a template package version to Advance ahead of making it available to users.

Authentication

See Authentication for more information about authenticating requests to the Advance API.

API Documentation

You can view the latest documentation for the Advance API at http://hotdocsadvance.com/api/rest/documentation/index.html

Request

Request URL

POST https://{tenancymoniker}.hotdocsadvance.com/rest/v1.1/TemplatePackageVersions/{templatePackageVersionId}/LiveDate

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.
templatePackageVersionId	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.

Examples

Example Request URL

https://yourtenancy.hotdocsadvance.com/rest/v1.1/TemplatePackageVersions/4a404239-527c-4470-b53f-7cc7f46445bd/LiveDate

Example Request JSON

{

"liveFromDate: "2020-01-22T16:56:57.687Z",

}

Example Response

Status: 200