Update an activity
curl --request PATCH \
--url https://api.chatsailer.com/v1/activities/{activity_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"assignee_id": "usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"description": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"title": "<string>"
}
'import requests
url = "https://api.chatsailer.com/v1/activities/{activity_id}"
payload = {
"assignee_id": "usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"description": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"title": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
assignee_id: 'usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
description: '<string>',
due_at: '2023-11-07T05:31:56Z',
title: '<string>'
})
};
fetch('https://api.chatsailer.com/v1/activities/{activity_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.chatsailer.com/v1/activities/{activity_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([
'assignee_id' => 'usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
'description' => '<string>',
'due_at' => '2023-11-07T05:31:56Z',
'title' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.chatsailer.com/v1/activities/{activity_id}"
payload := strings.NewReader("{\n \"assignee_id\": \"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"description\": \"<string>\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"title\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.chatsailer.com/v1/activities/{activity_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"assignee_id\": \"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"description\": \"<string>\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chatsailer.com/v1/activities/{activity_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"assignee_id\": \"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"description\": \"<string>\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"id": "act_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"status": "open",
"title": "<string>",
"type": "task",
"updated_at": "2023-11-07T05:31:56Z",
"assignee": {
"id": "<string>",
"kind": "user",
"name": "<string>",
"object": "owner"
},
"created_by": {
"id": "<string>",
"kind": "user",
"name": "<string>",
"object": "owner"
},
"object": "activity",
"record_id": "con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"status_reason": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}Activities
Update an activity
Only the fields you send change. Send status: completed to complete an activity, or status: canceled to call it off.
PATCH
/
v1
/
activities
/
{activity_id}
Update an activity
curl --request PATCH \
--url https://api.chatsailer.com/v1/activities/{activity_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"assignee_id": "usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"description": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"title": "<string>"
}
'import requests
url = "https://api.chatsailer.com/v1/activities/{activity_id}"
payload = {
"assignee_id": "usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"description": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"title": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
assignee_id: 'usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
description: '<string>',
due_at: '2023-11-07T05:31:56Z',
title: '<string>'
})
};
fetch('https://api.chatsailer.com/v1/activities/{activity_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.chatsailer.com/v1/activities/{activity_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([
'assignee_id' => 'usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
'description' => '<string>',
'due_at' => '2023-11-07T05:31:56Z',
'title' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.chatsailer.com/v1/activities/{activity_id}"
payload := strings.NewReader("{\n \"assignee_id\": \"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"description\": \"<string>\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"title\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.chatsailer.com/v1/activities/{activity_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"assignee_id\": \"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"description\": \"<string>\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chatsailer.com/v1/activities/{activity_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"assignee_id\": \"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"description\": \"<string>\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"id": "act_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"status": "open",
"title": "<string>",
"type": "task",
"updated_at": "2023-11-07T05:31:56Z",
"assignee": {
"id": "<string>",
"kind": "user",
"name": "<string>",
"object": "owner"
},
"created_by": {
"id": "<string>",
"kind": "user",
"name": "<string>",
"object": "owner"
},
"object": "activity",
"record_id": "con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"status_reason": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}Authorizations
A workspace API token (sk_live_...) or an OAuth access token (oat_live_...). Create workspace tokens in Settings > API. Send either as Authorization: Bearer <token>.
Headers
A unique value (a UUID works) that makes retrying this request safe. A repeat with the same key and body within 24 hours returns the original response instead of acting twice; the same key with a different body is a 409 idempotency_key_reused.
Maximum string length:
255Path Parameters
Unique identifier for an activity.
Pattern:
^act_[0-9a-f]{32}$Example:
"act_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Body
application/json
Body for PATCH /v1/activities/{activity_id}.
Only the fields you send change. Send status: completed to complete an
activity. Activities of type resume_conversation accept only a status
of completed or canceled.
Unique identifier for an user.
Pattern:
^usr_[0-9a-f]{32}$Example:
"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Available options:
open, completed, canceled Required string length:
1 - 500Available options:
task, call, email, meeting, follow_up Response
Successful Response
A call, meeting, task or other action planned or logged against a record.
When it is planned for, or when it happened. May be past.
Unique identifier for an activity.
Pattern:
^act_[0-9a-f]{32}$Example:
"act_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
suggested is proposed but not yet accepted; conflict means it could not be carried out automatically — status_reason says why.
Available options:
open, completed, canceled, conflict, suggested resume_conversation is the AI agent's plan to message the contact again at due_at; it can be read and canceled here, not created.
Available options:
task, call, email, meeting, follow_up, resume_conversation Who is responsible for doing it.
Show child attributes
Show child attributes
Who planned it. Null when an integration created it.
Show child attributes
Show child attributes
Allowed value:
"activity"Id of a contact, organization or deal. The prefix names the kind of record.
Pattern:
^(con|org|deal)_[0-9a-f]{32}$Example:
"con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Why the activity was canceled or could not be carried out.