Updates selected template fields. Use this method to remove or restore a template by changing its status.
https://api.doboard.com/{account_id}/task_template_update
account_id is the numeric organization identifier.
Supported methods: GET and POST. GET accepts query parameters; POST accepts the same parameters in an application/x-www-form-urlencoded request body.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
session_id |
string | Yes | — | Authenticated session ID. |
template_id |
int | Yes | — | Positive ID of the template to update. |
name |
string | No | Unchanged | Nonempty catalog name, maximum 256 characters. |
task_name |
string | No | Unchanged | Nonempty default task name, maximum 256 characters. |
content |
string | No | Unchanged | Prepared HTML content. Empty string clears the content. |
template_group_id |
int or null | No | Unchanged | Active Template Group ID. null removes the template from its group. |
label_ids |
array of int | No | Unchanged | Replaces the complete set of ordinary labels. Empty array clears labels. |
status |
enum | No | Unchanged | ACTIVE or REMOVED. |
name and task_name are edited independently. Changing the catalog name does not automatically change the default task name.content="" clears the text.template_group_id=null moves the template to “Ungrouped”. For a form-urlencoded request, send template_group_id= to represent this value.label_ids=[] clears labels. For a form-urlencoded request, send label_ids= to represent an empty array; for a nonempty array use label_ids[]=12&label_ids[]=35.status=REMOVED removes the template; status=ACTIVE restores it. If its previous group is no longer active and no new group is supplied, the template moves to “Ungrouped”.Change the catalog name and content:
POST /42/task_template_update HTTP/1.1
Host: api.doboard.com
Content-Type: application/x-www-form-urlencoded
session_id=YOUR_SESSION_ID&template_id=101&name=Detailed+bug+report&content=%3Cp%3EExpected+result%3A%3C%2Fp%3E
Move to “Ungrouped” and clear labels:
POST /42/task_template_update HTTP/1.1
Host: api.doboard.com
Content-Type: application/x-www-form-urlencoded
session_id=YOUR_SESSION_ID&template_id=101&template_group_id=&label_ids=
Remove:
POST /42/task_template_update HTTP/1.1
Host: api.doboard.com
Content-Type: application/x-www-form-urlencoded
session_id=YOUR_SESSION_ID&template_id=101&status=REMOVED
Restore:
POST /42/task_template_update HTTP/1.1
Host: api.doboard.com
Content-Type: application/x-www-form-urlencoded
session_id=YOUR_SESSION_ID&template_id=101&status=ACTIVE
Successful response:
{
"data": {
"operation_status": "SUCCESS",
"template_id": 101
}
}
| HTTP Code | error_no |
Message | Description |
|---|---|---|---|
401 |
401 |
session_id Unknown |
Missing or invalid session. |
403 |
403 |
Permission denied |
The request is forbidden. |
200 |
9001 |
Validation message (listed below) |
Missing, malformed or out-of-range input. |
200 |
9002 |
Template Not Found |
The template does not exist. |
200 |
9003 |
Template Group Not Found |
The selected group does not exist or is removed. |
200 |
9006 |
label_ids must be an array of positive integers / label_ids must reference active ordinary labels |
Invalid label array, missing or inactive labels, or action labels. |
200 |
9007 |
UNSUPPORTED_TEMPLATE_ATTACHMENT |
Embedded images, CSS image URLs or internal attachment references. |
200 |
0 |
Internal API Error |
An operation could not be completed. |
9001 messages:
{field} must be an integer between {minimum} and 4294967295{field} is required and must not exceed {limit} characterscontent must be a UTF-8 string not exceeding 16777215 bytescontent must not exceed 16777215 bytesstatus must be in ('ACTIVE','REMOVED')Empty inputPlaceholders in messages are replaced with the parameter name and its supported bounds.
Errors return data.operation_status="FAILED"; the same message is provided in error_message and data.operation_message.
The method validates:
UNSUPPORTED_TEMPLATE_ATTACHMENT.