curl --request PATCH \
--url https://api.assembly.com/v1/notes/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"content": "Revised the rollout timeline after the kickoff call.",
"title": "Updated onboarding summary"
}
'import requests
url = "https://api.assembly.com/v1/notes/{id}"
payload = {
"content": "Revised the rollout timeline after the kickoff call.",
"title": "Updated onboarding summary"
}
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({
content: 'Revised the rollout timeline after the kickoff call.',
title: 'Updated onboarding summary'
})
};
fetch('https://api.assembly.com/v1/notes/{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/notes/{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([
'content' => 'Revised the rollout timeline after the kickoff call.',
'title' => 'Updated onboarding summary'
]),
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/notes/{id}"
payload := strings.NewReader("{\n \"content\": \"Revised the rollout timeline after the kickoff call.\",\n \"title\": \"Updated onboarding summary\"\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/notes/{id}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"Revised the rollout timeline after the kickoff call.\",\n \"title\": \"Updated onboarding summary\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/notes/{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 \"content\": \"Revised the rollout timeline after the kickoff call.\",\n \"title\": \"Updated onboarding summary\"\n}"
response = http.request(request)
puts response.read_body{
"content": "Discussed the rollout timeline and next steps.",
"createdAt": "<string>",
"creatorId": "7b1c5d9e-2f34-4a8b-9c0d-1e2f3a4b5c6d",
"data": "<string>",
"entityId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"entityType": "client",
"id": "<string>",
"identityId": "<string>",
"object": "<string>",
"portalId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"previousAttributes": {},
"ref": "<string>",
"title": "Onboarding call summary",
"updatedAt": "<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>"
}Update a note
Updates the title and/or content of an existing note. Only the fields supplied are changed. Only internal users with access to the note’s entity can update it.
curl --request PATCH \
--url https://api.assembly.com/v1/notes/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"content": "Revised the rollout timeline after the kickoff call.",
"title": "Updated onboarding summary"
}
'import requests
url = "https://api.assembly.com/v1/notes/{id}"
payload = {
"content": "Revised the rollout timeline after the kickoff call.",
"title": "Updated onboarding summary"
}
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({
content: 'Revised the rollout timeline after the kickoff call.',
title: 'Updated onboarding summary'
})
};
fetch('https://api.assembly.com/v1/notes/{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/notes/{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([
'content' => 'Revised the rollout timeline after the kickoff call.',
'title' => 'Updated onboarding summary'
]),
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/notes/{id}"
payload := strings.NewReader("{\n \"content\": \"Revised the rollout timeline after the kickoff call.\",\n \"title\": \"Updated onboarding summary\"\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/notes/{id}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"Revised the rollout timeline after the kickoff call.\",\n \"title\": \"Updated onboarding summary\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/notes/{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 \"content\": \"Revised the rollout timeline after the kickoff call.\",\n \"title\": \"Updated onboarding summary\"\n}"
response = http.request(request)
puts response.read_body{
"content": "Discussed the rollout timeline and next steps.",
"createdAt": "<string>",
"creatorId": "7b1c5d9e-2f34-4a8b-9c0d-1e2f3a4b5c6d",
"data": "<string>",
"entityId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"entityType": "client",
"id": "<string>",
"identityId": "<string>",
"object": "<string>",
"portalId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"previousAttributes": {},
"ref": "<string>",
"title": "Onboarding call summary",
"updatedAt": "<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
Note ID
Body
Fields to update
Response
OK
Content is the body of the note.
"Discussed the rollout timeline and next steps."
CreatorId is the ID of the internal user who created the note. TODO(@foley): Let's remove this and use CreatedBy from Model, we'll need to do some backward compatibility work for the platform API.
"7b1c5d9e-2f34-4a8b-9c0d-1e2f3a4b5c6d"
ForeignKeyId is the ID of the client or company the note is attached to.
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
ForeignKeyType is the kind of entity the note is attached to.
client, company "client"
PortalID is the workspace the note belongs to.
"a1b2c3d4-5678-90ab-cdef-1234567890ab"
Title is the short heading of the note.
"Onboarding call summary"