Using room templates and task lists

You can save time and simplify your company’s processes by using a room template and one or more task lists when you create a new room. For example, if your company has a common set of steps and requirements for each mortgage loan transaction, you could create a room template containing that common task list data and use it to pre-populate each new mortgage loan room. This would ensure that every time someone creates a mortgage loan transaction room, it would also include all of the required tasks.

Templates are created for one side of a transaction (if in Rooms for Real Estate), are locked to a region/office, and may contain one or more task lists. The tasks defined in a task list hold the bulk of template data and can include:

• Due dates

• Required assignee actions and permissions associated with the task

• Descriptions of the documents associated with the task

• The roles which have actions associated with the task

• Reminders, and when they will be delivered

  Note: A single task list may be part of multiple templates, so long as they are set to the same region/office.

Create a room from a template

Before creating a room from a template, you should first:

1. Add a Task list. Task lists contain one or more tasks that room members can complete. See Create Task List Templates to Group Common Transaction Activities for details on how to create a task list.
2. Define a room template, which contains your task list. See Create Room Templates to Auto-Populate New Rooms With Task Lists for details on how to create a room template.

Once you have a template, you can use it to create a new room with the Rooms UI or the Rooms:CreateRoom method. See Create Room Templates to Auto-Populate New Rooms With Task List for details on how to create a room with a template using the UI.

To create a room from your template with the API Rooms:CreateRoom method, you must provide the ID of the template to be used in the body of the request.

Note: To find your API Account ID, log in to eSignature Admin and select Apps and Keys in the Integrations section of the left nav bar to open the API and Integration Key Information page. Your API Account ID is shown in the My Account Information section.

The following example API call demonstrates how to create a room from a previously defined template:

Note: You can get the IDs of your templates by using the RoomTemplates:GetRoomTemplates method, which will return data about all of the room templates you can access.

These examples require the following data:

See how to create a Room with a template for a more detailed, in-depth code example demonstrating how to create a new room using a template in a variety of languages.

$headers = New-Object
"System.Collections.Generic.Dictionary[[String],[String]]"
$headers.add("Authorization","Bearer {ACCESS_TOKEN}")
$headers.add("Accept", "application/json")
$headers.add("Content-Type", "application/json")
$body = @"
{
  "name": "Example Property 2818 SW Alaska St",
  "roleId": 292949,
  "templateId": 1140,
  "transactionSideId": "listbuy",
  "officeId": 11570
}
"@
$uri = "https://demo.rooms.docusign.com/restapi/v2/accounts/{ACCOUNT_ID}/rooms"
$result = Invoke-WebRequest -headers $headers -Uri $uri -Method POST -Body $body
$result.Content

Next steps

• Create Task List Templates to Group Common Transaction Activities
• Create Room Templates to Auto-Populate New Rooms With Task Lists
• Create Room Templates to Auto-Populate New Rooms With Task List
• How to create a room with a template