Update a task
curl --request PATCH \
--url https://api.assembly.com/v1/tasks/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"clientId": "64734088-94c7-47dd-b2fe-e5ac7e5cfaf4",
"companyId": "550e8400-e29b-41d4-a716-446655440000",
"description": "Write the welcome email for new clients.",
"dueDate": "2025-05-01T16:18:54Z",
"internalUserId": "64734088-94c7-47dd-b2fe-e5ac7e5cfaf4",
"isArchived": false,
"name": "Draft the onboarding email",
"parentTaskId": "550e8400-e29b-41d4-a716-446655440000",
"status": "todo",
"templateId": "550e8400-e29b-41d4-a716-446655440000",
"viewers": [
{
"clientId": "64734088-94c7-47dd-b2fe-e5ac7e5cfaf4",
"companyId": "550e8400-e29b-41d4-a716-446655440000"
}
]
}
'import requests
url = "https://api.assembly.com/v1/tasks/{id}"
payload = {
"clientId": "64734088-94c7-47dd-b2fe-e5ac7e5cfaf4",
"companyId": "550e8400-e29b-41d4-a716-446655440000",
"description": "Write the welcome email for new clients.",
"dueDate": "2025-05-01T16:18:54Z",
"internalUserId": "64734088-94c7-47dd-b2fe-e5ac7e5cfaf4",
"isArchived": False,
"name": "Draft the onboarding email",
"parentTaskId": "550e8400-e29b-41d4-a716-446655440000",
"status": "todo",
"templateId": "550e8400-e29b-41d4-a716-446655440000",
"viewers": [
{
"clientId": "64734088-94c7-47dd-b2fe-e5ac7e5cfaf4",
"companyId": "550e8400-e29b-41d4-a716-446655440000"
}
]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clientId: '64734088-94c7-47dd-b2fe-e5ac7e5cfaf4',
companyId: '550e8400-e29b-41d4-a716-446655440000',
description: 'Write the welcome email for new clients.',
dueDate: '2025-05-01T16:18:54Z',
internalUserId: '64734088-94c7-47dd-b2fe-e5ac7e5cfaf4',
isArchived: false,
name: 'Draft the onboarding email',
parentTaskId: '550e8400-e29b-41d4-a716-446655440000',
status: 'todo',
templateId: '550e8400-e29b-41d4-a716-446655440000',
viewers: [
{
clientId: '64734088-94c7-47dd-b2fe-e5ac7e5cfaf4',
companyId: '550e8400-e29b-41d4-a716-446655440000'
}
]
})
};
fetch('https://api.assembly.com/v1/tasks/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.assembly.com/v1/tasks/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'clientId' => '64734088-94c7-47dd-b2fe-e5ac7e5cfaf4',
'companyId' => '550e8400-e29b-41d4-a716-446655440000',
'description' => 'Write the welcome email for new clients.',
'dueDate' => '2025-05-01T16:18:54Z',
'internalUserId' => '64734088-94c7-47dd-b2fe-e5ac7e5cfaf4',
'isArchived' => false,
'name' => 'Draft the onboarding email',
'parentTaskId' => '550e8400-e29b-41d4-a716-446655440000',
'status' => 'todo',
'templateId' => '550e8400-e29b-41d4-a716-446655440000',
'viewers' => [
[
'clientId' => '64734088-94c7-47dd-b2fe-e5ac7e5cfaf4',
'companyId' => '550e8400-e29b-41d4-a716-446655440000'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.assembly.com/v1/tasks/{id}"
payload := strings.NewReader("{\n \"clientId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"description\": \"Write the welcome email for new clients.\",\n \"dueDate\": \"2025-05-01T16:18:54Z\",\n \"internalUserId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"isArchived\": false,\n \"name\": \"Draft the onboarding email\",\n \"parentTaskId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"status\": \"todo\",\n \"templateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"viewers\": [\n {\n \"clientId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.assembly.com/v1/tasks/{id}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"description\": \"Write the welcome email for new clients.\",\n \"dueDate\": \"2025-05-01T16:18:54Z\",\n \"internalUserId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"isArchived\": false,\n \"name\": \"Draft the onboarding email\",\n \"parentTaskId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"status\": \"todo\",\n \"templateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"viewers\": [\n {\n \"clientId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/tasks/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"description\": \"Write the welcome email for new clients.\",\n \"dueDate\": \"2025-05-01T16:18:54Z\",\n \"internalUserId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"isArchived\": false,\n \"name\": \"Draft the onboarding email\",\n \"parentTaskId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"status\": \"todo\",\n \"templateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"viewers\": [\n {\n \"clientId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2024-01-15T09:30:00Z",
"deleted": true,
"description": "Write the welcome email for new clients.",
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Draft the onboarding email",
"object": "client",
"updatedAt": "2024-02-20T14:05:00Z"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}Tasks
Update a task
Partially updates a task by id via the Tasks marketplace app installed on the workspace. Only the provided fields are changed. The request is proxied to the app’s task API. Requires the Tasks app to be installed.
PATCH
/
v1
/
tasks
/
{id}
Update a task
curl --request PATCH \
--url https://api.assembly.com/v1/tasks/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"clientId": "64734088-94c7-47dd-b2fe-e5ac7e5cfaf4",
"companyId": "550e8400-e29b-41d4-a716-446655440000",
"description": "Write the welcome email for new clients.",
"dueDate": "2025-05-01T16:18:54Z",
"internalUserId": "64734088-94c7-47dd-b2fe-e5ac7e5cfaf4",
"isArchived": false,
"name": "Draft the onboarding email",
"parentTaskId": "550e8400-e29b-41d4-a716-446655440000",
"status": "todo",
"templateId": "550e8400-e29b-41d4-a716-446655440000",
"viewers": [
{
"clientId": "64734088-94c7-47dd-b2fe-e5ac7e5cfaf4",
"companyId": "550e8400-e29b-41d4-a716-446655440000"
}
]
}
'import requests
url = "https://api.assembly.com/v1/tasks/{id}"
payload = {
"clientId": "64734088-94c7-47dd-b2fe-e5ac7e5cfaf4",
"companyId": "550e8400-e29b-41d4-a716-446655440000",
"description": "Write the welcome email for new clients.",
"dueDate": "2025-05-01T16:18:54Z",
"internalUserId": "64734088-94c7-47dd-b2fe-e5ac7e5cfaf4",
"isArchived": False,
"name": "Draft the onboarding email",
"parentTaskId": "550e8400-e29b-41d4-a716-446655440000",
"status": "todo",
"templateId": "550e8400-e29b-41d4-a716-446655440000",
"viewers": [
{
"clientId": "64734088-94c7-47dd-b2fe-e5ac7e5cfaf4",
"companyId": "550e8400-e29b-41d4-a716-446655440000"
}
]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clientId: '64734088-94c7-47dd-b2fe-e5ac7e5cfaf4',
companyId: '550e8400-e29b-41d4-a716-446655440000',
description: 'Write the welcome email for new clients.',
dueDate: '2025-05-01T16:18:54Z',
internalUserId: '64734088-94c7-47dd-b2fe-e5ac7e5cfaf4',
isArchived: false,
name: 'Draft the onboarding email',
parentTaskId: '550e8400-e29b-41d4-a716-446655440000',
status: 'todo',
templateId: '550e8400-e29b-41d4-a716-446655440000',
viewers: [
{
clientId: '64734088-94c7-47dd-b2fe-e5ac7e5cfaf4',
companyId: '550e8400-e29b-41d4-a716-446655440000'
}
]
})
};
fetch('https://api.assembly.com/v1/tasks/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.assembly.com/v1/tasks/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'clientId' => '64734088-94c7-47dd-b2fe-e5ac7e5cfaf4',
'companyId' => '550e8400-e29b-41d4-a716-446655440000',
'description' => 'Write the welcome email for new clients.',
'dueDate' => '2025-05-01T16:18:54Z',
'internalUserId' => '64734088-94c7-47dd-b2fe-e5ac7e5cfaf4',
'isArchived' => false,
'name' => 'Draft the onboarding email',
'parentTaskId' => '550e8400-e29b-41d4-a716-446655440000',
'status' => 'todo',
'templateId' => '550e8400-e29b-41d4-a716-446655440000',
'viewers' => [
[
'clientId' => '64734088-94c7-47dd-b2fe-e5ac7e5cfaf4',
'companyId' => '550e8400-e29b-41d4-a716-446655440000'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.assembly.com/v1/tasks/{id}"
payload := strings.NewReader("{\n \"clientId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"description\": \"Write the welcome email for new clients.\",\n \"dueDate\": \"2025-05-01T16:18:54Z\",\n \"internalUserId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"isArchived\": false,\n \"name\": \"Draft the onboarding email\",\n \"parentTaskId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"status\": \"todo\",\n \"templateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"viewers\": [\n {\n \"clientId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.assembly.com/v1/tasks/{id}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"description\": \"Write the welcome email for new clients.\",\n \"dueDate\": \"2025-05-01T16:18:54Z\",\n \"internalUserId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"isArchived\": false,\n \"name\": \"Draft the onboarding email\",\n \"parentTaskId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"status\": \"todo\",\n \"templateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"viewers\": [\n {\n \"clientId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/tasks/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"description\": \"Write the welcome email for new clients.\",\n \"dueDate\": \"2025-05-01T16:18:54Z\",\n \"internalUserId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"isArchived\": false,\n \"name\": \"Draft the onboarding email\",\n \"parentTaskId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"status\": \"todo\",\n \"templateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"viewers\": [\n {\n \"clientId\": \"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4\",\n \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2024-01-15T09:30:00Z",
"deleted": true,
"description": "Write the welcome email for new clients.",
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Draft the onboarding email",
"object": "client",
"updatedAt": "2024-02-20T14:05:00Z"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}Authorizations
Path Parameters
Task id
Body
application/json
Task fields to update
ClientID assigns the task to a client user; CompanyID is required when set.
Example:
"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4"
CompanyID assigns the task to a company; required when assigning to a client.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Description is the optional long-form details of the task.
Example:
"Write the welcome email for new clients."
DueDate is when the task is due, in RFC 3339 format.
Example:
"2025-05-01T16:18:54Z"
InternalUserID assigns the task to an internal user.
Example:
"64734088-94c7-47dd-b2fe-e5ac7e5cfaf4"
IsArchived archives or unarchives the task. Used when updating a task.
Example:
false
Name is the human-readable name of the task.
Example:
"Draft the onboarding email"
ParentTaskID makes this task a subtask of the given parent task.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Status is the task status: one of todo, inProgress, completed.
Available options:
todo, inProgress, completed Example:
"todo"
TemplateID is the task template to create this task from.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Viewers grant view access to the task (assignee must be an internal user).
Show child attributes
Show child attributes
Response
OK
Created is the RFC 3339 timestamp at which the object was created.
Example:
"2024-01-15T09:30:00Z"
Deleted is true when the object has been deleted; present only on delete responses.
Example:
true
Description is the optional long-form details of the task.
Example:
"Write the welcome email for new clients."
ID is the unique identifier of the object.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Name is the human-readable title of the task.
Example:
"Draft the onboarding email"
Object is the type of the object (e.g. "client", "company").
Available options:
client, internalUser, company, customField, customFieldOption, file, fileChannel, folder, messageChannel, message, notification Updated is the RFC 3339 timestamp at which the object was last updated.
Example:
"2024-02-20T14:05:00Z"