Task Templates: Overview of Methods

Task templates help to describe a typical workflow in advance and use a unified set of settings for new tasks. A template can save the task title and description, participants, deadlines, project, recurrence, checklist, and other fields.

Quick navigation: all methods

User documentation: How to work with task templates

Getting StartedGetting Started

1. Define the fields of the template on the Task Template Fields page or obtain their description using the tasks.template.fields method.
2. If the template is to create recurring tasks, configure the REPLICATE and REPLICATE_PARAMS fields.
3. Obtain the identifiers of users, groups, and CRM entities if references to these objects are needed in the template.
4. Create the template using the tasks.template.add method.
5. Retrieve the template using the tasks.template.get method if you need to check the saved values.
6. Modify the template using the tasks.template.update method if you need to adjust the parameters.
7. Add checklist items using the methods from the Task Template Checklists section if the task consists of recurring steps.
8. Delete the template using the tasks.template.delete method if it is no longer needed.

Access PermissionsAccess Permissions

Permissions for working with task templates depend on the access settings in tasks.

Relationships with Other ObjectsRelationships with Other Objects

Tasks. The template stores the settings for the future task: title, description, deadlines, responsible persons, observers, checklist, and other parameters. Use the methods from the Tasks section to work with tasks.

Users. In the template, you can specify the Creator, main Participant, other Participants, and observers through the fields CREATED_BY, RESPONSIBLE_ID, RESPONSIBLES, ACCOMPLICES, AUDITORS. User identifiers can be obtained using the user.get and user.search methods.

Groups and Projects. To link the template to a group or project, use the GROUP_ID field. This allows you to create tasks in the desired workspace. The identifier of the group or project can be obtained using the sonet_group.get and socialnetwork.api.workgroup.list methods.

CRM. The template can pre-save links to CRM entities. In the UF_CRM_TASK field, specify the identifiers of CRM entities with a prefix, for example, L_15 for a lead or D_27 for a deal. Identifiers of existing entities can be obtained using the crm.item.list method. If the entity needs to be created first, use crm.item.add.

Checklists. If the typical task consists of recurring steps, add them to the template using the methods from the Task Template Checklists subsection.

Overview of MethodsOverview of Methods

Scope: task

Who can execute the method: depending on the method

Main MethodsMain Methods

Method	Description
tasks.template.add	Adds a task template
tasks.template.update	Modifies a task template
tasks.template.get	Retrieves a task template by id
tasks.template.delete	Deletes a task template
tasks.template.fields	Retrieves the description of task template fields

Task Template ChecklistsTask Template Checklists

Method	Description
tasks.template.checklist.add	Adds a checklist item
tasks.template.checklist.update	Updates a checklist item
tasks.template.checklist.get	Retrieves a checklist item by id
tasks.template.checklist.list	Retrieves a list of checklist items
tasks.template.checklist.delete	Deletes a checklist item
tasks.template.checklist.moveAfter	Moves an item after the specified one
tasks.template.checklist.moveBefore	Moves an item before the specified one
tasks.template.checklist.complete	Marks an item as completed
tasks.template.checklist.renew	Returns an item to an incomplete state
tasks.template.checklist.addAttachmentByContent	Adds an attachment from content
tasks.template.checklist.addAttachmentsFromDisk	Adds attachments from Drive
tasks.template.checklist.removeAttachments	Removes attachments from a checklist item