Task Template Fields
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
This page describes the fields of a task template object. For an overview of template methods, see Task Templates.
The fields in the table are used in requests to tasks.template.add and tasks.template.update, and are returned in responses from template methods. To retrieve the current field metadata for a specific account, use tasks.template.fields.
Choose the source according to your task:
- Task Template Fields — to understand field purposes and allowed values
- tasks.template.fields — to retrieve field metadata for a specific account
- tasks.template.get — to retrieve saved template values by identifier
- tasks.template.add and tasks.template.update — to pass fields when creating or updating a template
The field type in the table describes the REST API data format. The set and types of UF_* custom fields depend on the settings of a specific account.
Access to tasks is required to work with templates. Available actions and some field values depend on the user's permissions and account settings.
|
Name |
Description |
|
ID |
Template identifier. In tasks.template.add, the input field |
|
PARENT_ID |
Parent task identifier. Default is |
|
TITLE |
Template title |
|
DESCRIPTION |
Template description |
|
PRIORITY |
Priority |
|
GROUP_ID |
Project identifier. Default is |
|
STAGE_ID |
Stage identifier. Default is |
|
CREATED_BY |
Creator identifier |
|
RESPONSIBLE_ID |
Responsible person identifier |
|
DEPENDS_ON |
Array of template identifiers that the current template depends on. In the response from tasks.template.fields, this field is described as |
|
RESPONSIBLES |
List of responsible persons |
|
ACCOMPLICES |
List of participants |
|
AUDITORS |
List of auditors |
|
STATUS |
Status |
|
MULTITASK |
Multitasking indicator. Possible values:
Default is |
|
REPLICATE |
Recurring task indicator. Possible values:
Default is |
|
SITE_ID |
Site identifier |
|
TASK_CONTROL |
Accept work. Possible values:
Default is |
|
ADD_IN_REPORT |
Add to report. Possible values:
Default is |
|
XML_ID |
External identifier. Default is |
|
DEADLINE_AFTER |
Deadline after. Default is |
|
START_DATE_PLAN_AFTER |
Planned start after. Default is |
|
END_DATE_PLAN_AFTER |
Planned completion after. Default is |
|
TPARAM_TYPE |
For new users. Default is |
|
TPARAM_REPLICATION_COUNT |
Number of created tasks. Default is |
|
REPLICATE_PARAMS |
Template replication parameters (detailed description) |
|
BASE_TEMPLATE_ID |
Parent template identifier. Default is |
|
TEMPLATE_CHILDREN_COUNT |
Number of child templates. Default is |
|
UF_ fields* |
Custom fields of the object |
To obtain a complete list of custom fields for a specific account, use the tasks.template.fields method.
REPLICATE_PARAMS Parameter
General Replication Parameters
|
Name |
Description |
|
PERIOD |
Type of repetition. Possible values: |
|
START_DATE |
Start date and time of repetition in the format |
|
TIME |
Start time in the format Default is |
|
REPEAT_TILL |
Repetition end mode. Possible values:
|
|
TIMES |
Number of repetitions. Used when |
|
END_DATE |
End date of repetition in the format Used when |
|
NEXT_EXECUTION_TIME |
Date and time of the next execution |
|
DEADLINE_OFFSET |
Deadline offset relative to the start time |
Parameters for Daily Repetition PERIOD = daily
|
Name |
Description |
|
EVERY_DAY |
Repetition interval in days. Value from |
|
WORKDAY_ONLY |
Consider only working days. Possible values: |
|
DAILY_MONTH_INTERVAL |
Additional interval for daily repetition. Value from |
Parameters for Weekly Repetition PERIOD = weekly
|
Name |
Description |
|
EVERY_WEEK |
Repetition interval in weeks. Value from |
|
WEEK_DAYS |
Days of the week for execution. Possible values for array elements:
|
Parameters for Monthly Repetition PERIOD = monthly
|
Name |
Description |
|
MONTHLY_TYPE |
Type of monthly repetition. Possible values:
|
|
MONTHLY_DAY_NUM |
Day of the month. Used when |
|
MONTHLY_MONTH_NUM_1 |
Month interval for the "by day of the month" scheme. Used when |
|
MONTHLY_WEEK_DAY_NUM |
Week number in the month. Used when
|
|
MONTHLY_WEEK_DAY |
Day of the week in the "by day of the week" scheme. Used when
|
|
MONTHLY_MONTH_NUM_2 |
Month interval for the "by day of the week" scheme. Used when |
Parameters for Yearly Repetition PERIOD = yearly
|
Name |
Description |
|
YEARLY_TYPE |
Type of yearly repetition. Possible values:
|
|
YEARLY_DAY_NUM |
Day of the month. Used when |
|
YEARLY_MONTH_1 |
Month for the "by day of the month" scheme. Used when
|
|
YEARLY_WEEK_DAY_NUM |
Week number in the month. Used when
|
|
YEARLY_WEEK_DAY |
Day of the week in the "by day of the week" scheme. Used when
|
|
YEARLY_MONTH_2 |
Month for the "by day of the week" scheme. Used when
|