Update Note
Replace a note's text and annotations. This operation is experimental.
Requires notes:write. This example clears existing annotations with annotations: [].
See the Notes guide for the complete workflow and error handling.
mutation UpdateNote {
updateCollaborationNote(input: {
noteId: "YOUR_NOTE_ID"
text: "The revised caption is ready for review."
annotations: []
}) {
__typename
... on UpdateCollaborationNoteSuccess { note { id text allowedActions } }
... on MutationError { message }
}
}
curl -X POST 'https://api.buffer.com' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-d '{"query": "mutation UpdateNote {\n updateCollaborationNote(input: {\n noteId: \"YOUR_NOTE_ID\"\n text: \"The revised caption is ready for review.\"\n annotations: []\n }) {\n __typename\n ... on UpdateCollaborationNoteSuccess { note { id text allowedActions } }\n ... on MutationError { message }\n }\n}"}'
async function updateNote() {
const response = await fetch('https://api.buffer.com', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer YOUR_API_KEY',
},
body: JSON.stringify({
query: `
mutation UpdateNote {
updateCollaborationNote(input: {
noteId: "YOUR_NOTE_ID"
text: "The revised caption is ready for review."
annotations: []
}) {
__typename
... on UpdateCollaborationNoteSuccess { note { id text allowedActions } }
... on MutationError { message }
}
}
`,
}),
});
const data = await response.json();
console.log(JSON.stringify(data, null, 2));
}
updateNote();
import requests
query = """
mutation UpdateNote {
updateCollaborationNote(input: {
noteId: "YOUR_NOTE_ID"
text: "The revised caption is ready for review."
annotations: []
}) {
__typename
... on UpdateCollaborationNoteSuccess { note { id text allowedActions } }
... on MutationError { message }
}
}
"""
response = requests.post(
"https://api.buffer.com",
headers={
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_KEY",
},
json={
"query": query,
},
)
data = response.json()
print(data)
<?php
$query = '
mutation UpdateNote {
updateCollaborationNote(input: {
noteId: "YOUR_NOTE_ID"
text: "The revised caption is ready for review."
annotations: []
}) {
__typename
... on UpdateCollaborationNoteSuccess { note { id text allowedActions } }
... on MutationError { message }
}
}
';
$payload = [
'query' => $query,
];
$ch = curl_init('https://api.buffer.com');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'Authorization: Bearer YOUR_API_KEY',
],
CURLOPT_POSTFIELDS => json_encode($payload),
CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
An update replaces both text and annotations. Omitting annotations, passing null, or using an empty array clears existing annotations.