Choose where you’d like to start

Get Merge Templates in Zoho Writer

Description

The zoho.writer.getMergeTemplates task lists all the merge templates created by the user. This task is based on the Zoho Writer Get Merge Templates API.

Note: Applicable to all services except Zoho Creator.

Syntax

<response> = zoho.writer.getMergeTemplates(<optional_settings>, <connection>);

where:

ParamsData typeDescription
<response>KEY-VALUEThe response returned by Zoho Writer. It lists all the user's merge templates and their metadata.
<optional_settings>KEY-VALUEThe optional parameters you can send to fetch data according to your preference.
<connection>TEXT

The connection's link name.

Note:

  • To prevent new authtoken generation and ensure new integration tasks (created after the deadline specified in the post) work as expected, a Zoho OAuth connection with appropriate scopes is mandatory. Existing integration tasks will continue to work, with or without the connections parameter, until you manually delete the authtoken from Zoho Accounts.

  • Add relevant scopes from the Zoho Writer API when creating the connection.

  • Refer to this post for a list of Zoho services that support the Connections page.

  • Learn more about connections

 

optional_settings parameter values:

offsetinteger

Set offset parameter to get a list of merge templates from a specified page.

By default, offset value is 0.

limitinteger

Add a document limit to set the number of  merge templates to be fetched by the API.

By default, the limit value is 10.

sortbyString

created_time 
Get a list of merge templates sorted by created time.
modified_time
Get the list of merge templates with respect to the last modified time of the template.
name
Get the list of merge templates with respect to the template name.
 

Default date format: IS08601

By default, the templates will be sorted and listed based on the modified_time.

sort_order_byString

ascending
Get the list of merge templates in the ascending order based on the sortby param value configured.
descending
Get the list of merge templates in the descending order based on the sortby param value configured.

By default, the templates will be sorted and listed in the descending order.

categoryString

all
Get all the list of merge templates.
shared_to_me
Get only the list of merge templates which are shared to you.
owned_by_me
Get only the list of merge templates which are created by you.

By default, the category value will be all. Here, all the merge templates will be listed.

Example

The following script lists all of a user's merge templates in descending order based on document modified time in groups of five.

optional_settings = Map();
optional_settings.put("offset", "0");
optional_settings.put("limit", "5");
optional_settings.put("sortby", "modified_time");
optional_settings.put("sort_order_by", "descending");
optional_settings.put("category", "all");
response = zoho.writer.getMergeTemplates(optional_settings, "writer_oauth_connection");
info response;

where:

response
The KEY-VALUE response returned by Zoho Writer. It represents the page from where the list of merge templates for the user.
0
The INTEGER that represents from which page to get the list of merge templates.
5
The INTEGER which represents how many merge templates to get in a single call.
modified_time
The STRING which represents the sortby order
descending
The STRING which represents the display order
all
The STRING indicates all the user's merge templates will be retrieved.

Response Format

{
"documents": [
{
"document_name": "Presales tips",
"open_url": "https://writer.zoho.com/writer/open/1x3q99f2155c6737241ea929eb72ad141da7c",
"is_favourite": false,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/1x3q99f2155c6737241ea929eb72ad141da7c",
"document_id": "1x3q99f2155c6737241ea929eb72ad141da7d",
"type": "document",
"modified_time": "2020-06-23T10:13:11Z",
"download_url": "https://writer.zoho.com/writer/api/v1/download/1x3q99f2155c6737241ea929eb72ad141da7c",
"lastmodified_by": [
{
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=1234&fs=thumb",
"user_id": "456215787",
"timezone": "Asia/Kolkata",
"language": "en",
"display_name": "Amelia"
}
],
"created_time": "2020-06-16T08:46:40Z",
"last_opened_time": "2020-06-16T08:46:40Z",
"created_by": "Amelia",
"created_time_ms": 1592297200540,
"preview_url": "https://writer.zoho.com/writer/zwpreview/1x3q99f2155c6737241ea929eb72ad141da7c",
"creator_id": "53884257",
},
{
"open_url": "https://writer.zoho.com/writer/open/1slbxa0f3e1ecc88b4403b5f1b66617f0e92c",
"is_favourite": false,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/1slbxa0f3e1ecc88b4403b5f1b66617f0e92c",
"document_id": "1slbxa0f3e1ecc88b4403b5f1b66617f0e92c",
"type": "document",
"document_name": "Investment details",
"modified_time": "2020-12-01T12:56:50Z",
"download_url": "https://writer.zoho.com/writer/api/v1/download/1slbxa0f3e1ecc88b4403b5f1b66617f0e92c",
"lastmodified_by": [
{
"email_id": "John@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=53884257&fs=thumb",
"user_id": "53884257",
"timezone": "Asia/Kolkata",
"language": "en",
"display_name": "John"
}
],
"created_time": "2020-12-01T09:01:43Z",
"last_opened_time": "2020-12-01T09:01:43Z",
"created_by": "John",
"created_time_ms": 1606813303541,
"preview_url": "https://writer.zoho.com/writer/zwpreview/1slbxa0f3e1ecc88b4403b5f1b66617f0e92c",
"creator_id": "53884257",
},
{
"open_url": "https://writer.zoho.com/writer/open/ll60fcb6bfab23ffd4821804dc629bbd16656",
"is_favourite": false,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/ll60fcb6bfab23ffd4821804dc629bbd16656",
"document_id": "ll60fcb6bfab23ffd4821804dc629bbd16656",
"type": "document",
"document_name": "Finalised Document",
"modified_time": "2020-09-15T03:57:36Z",
"download_url": "https://writer.zoho.com/writer/api/v1/download/ll60fcb6bfab23ffd4821804dc629bbd16656",
"lastmodified_by": [
{
"email_id": "mike@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=648787570&fs=thumb",
"user_id": "648787570",
"timezone": "Asia/Kolkata",
"language": "en",
"display_name": "Mike"
}
],
"created_time": "2020-09-03T07:18:03Z",
"last_opened_time": "2020-09-03T07:18:03Z",
"created_by": "Mike",
"created_time_ms": 1599117483853,
"preview_url": "https://writer.zoho.com/writer/zwpreview/ll60fcb6bfab23ffd4821804dc629bbd16656",
"creator_id": "53884257",
"name": "New Document",
},
{
"open_url": "https://writer.zoho.com/writer/open/6zqn0d6f9ca0d3ba140f892b0603baae3e8d3",
"is_favourite": false,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/6zqn0d6f9ca0d3ba140f892b0603baae3e8d3",
"document_id": "6zqn0d6f9ca0d3ba140f892b0603baae3e8d3",
"type": "document",
"document_name": "Invoices",
"modified_time": "2020-09-25T03:54:17Z",
"download_url": "https://writer.zoho.com/writer/api/v1/download/6zqn0d6f9ca0d3ba140f892b0603baae3e8d3",
"lastmodified_by": [
{
"email_id": "jack@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=53884257&fs=thumb",
"user_id": "53884257",
"timezone": "Asia/Kolkata",
"language": "en",
"display_name": "Jack"
}
],
"created_time": "2020-09-21T08:48:32Z",
"last_opened_time": "2020-09-21T08:48:32Z",
"created_by": "Jack",
"created_time_ms": 1600678112999,
"preview_url": "https://writer.zoho.com/writer/zwpreview/6zqn0d6f9ca0d3ba140f892b0603baae3e8d3",
"creator_id": "53884257",
"name": "Product Details",
},
{
"open_url": "https://writer.zoho.com/writer/open/lvm1t3b4d9576b7b4415d958405b161ee0b67",
"is_favourite": false,
"thumbnail_url": "https://writer.zoho.com/writer/thumbnail/lvm1t3b4d9576b7b4415d958405b161ee0b67",
"document_id": "lvm1t3b4d9576b7b4415d958405b161ee0b67",
"type": "document",
"document_name": "Product prices",
"modified_time": "2020-12-10T11:19:35Z",
"download_url": "https://writer.zoho.com/writer/api/v1/download/lvm1t3b4d9576b7b4415d958405b161ee0b67",
"lastmodified_by": [
{
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=53884257&fs=thumb",
"user_id": "53884257",
"timezone": "Asia/Kolkata",
"language": "en",
"display_name": "Amelia"
}
],
"created_time": "2020-09-22T12:15:28Z",
"last_opened_time": "2020-09-22T12:15:28Z",
"created_by": "Amelia",
"created_time_ms": 1600776928655,
"preview_url": "https://writer.zoho.com/writer/zwpreview/lvm1t3b4d9576b7b4415d958405b161ee0b67",
"creator_id": "53884257",
"name": "Sample file",
}
],
"total_count": 33,
"limit": 5"
}

Related Links

Get Started Now

Execute