Update a Note by UUID.
curl --request PUT \
--url https://production-api.joinrings.com/v1/notes/{note_uuid} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"content": "<string>",
"date": 123,
"mentions": [
{
"type": "<string>",
"uuid": "<string>"
}
],
"owner_user_uuid": "<string>",
"subject": "<string>"
}
'import requests
url = "https://production-api.joinrings.com/v1/notes/{note_uuid}"
payload = {
"content": "<string>",
"date": 123,
"mentions": [
{
"type": "<string>",
"uuid": "<string>"
}
],
"owner_user_uuid": "<string>",
"subject": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
content: '<string>',
date: 123,
mentions: [{type: '<string>', uuid: '<string>'}],
owner_user_uuid: '<string>',
subject: '<string>'
})
};
fetch('https://production-api.joinrings.com/v1/notes/{note_uuid}', 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://production-api.joinrings.com/v1/notes/{note_uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'content' => '<string>',
'date' => 123,
'mentions' => [
[
'type' => '<string>',
'uuid' => '<string>'
]
],
'owner_user_uuid' => '<string>',
'subject' => '<string>'
]),
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://production-api.joinrings.com/v1/notes/{note_uuid}"
payload := strings.NewReader("{\n \"content\": \"<string>\",\n \"date\": 123,\n \"mentions\": [\n {\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"owner_user_uuid\": \"<string>\",\n \"subject\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://production-api.joinrings.com/v1/notes/{note_uuid}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"<string>\",\n \"date\": 123,\n \"mentions\": [\n {\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"owner_user_uuid\": \"<string>\",\n \"subject\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/notes/{note_uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"content\": \"<string>\",\n \"date\": 123,\n \"mentions\": [\n {\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"owner_user_uuid\": \"<string>\",\n \"subject\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"created_at": 123,
"updated_at": 123
}Note
Update a note
Only provided fields are written. If content is provided the S3
object is re-uploaded and the excerpt on the DB row is refreshed;
omitting content leaves the stored HTML untouched. 404s when the
note isn’t visible for the caller’s tenant.
PUT
/
v1
/
notes
/
{note_uuid}
Update a Note by UUID.
curl --request PUT \
--url https://production-api.joinrings.com/v1/notes/{note_uuid} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"content": "<string>",
"date": 123,
"mentions": [
{
"type": "<string>",
"uuid": "<string>"
}
],
"owner_user_uuid": "<string>",
"subject": "<string>"
}
'import requests
url = "https://production-api.joinrings.com/v1/notes/{note_uuid}"
payload = {
"content": "<string>",
"date": 123,
"mentions": [
{
"type": "<string>",
"uuid": "<string>"
}
],
"owner_user_uuid": "<string>",
"subject": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
content: '<string>',
date: 123,
mentions: [{type: '<string>', uuid: '<string>'}],
owner_user_uuid: '<string>',
subject: '<string>'
})
};
fetch('https://production-api.joinrings.com/v1/notes/{note_uuid}', 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://production-api.joinrings.com/v1/notes/{note_uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'content' => '<string>',
'date' => 123,
'mentions' => [
[
'type' => '<string>',
'uuid' => '<string>'
]
],
'owner_user_uuid' => '<string>',
'subject' => '<string>'
]),
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://production-api.joinrings.com/v1/notes/{note_uuid}"
payload := strings.NewReader("{\n \"content\": \"<string>\",\n \"date\": 123,\n \"mentions\": [\n {\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"owner_user_uuid\": \"<string>\",\n \"subject\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://production-api.joinrings.com/v1/notes/{note_uuid}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"<string>\",\n \"date\": 123,\n \"mentions\": [\n {\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"owner_user_uuid\": \"<string>\",\n \"subject\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/notes/{note_uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"content\": \"<string>\",\n \"date\": 123,\n \"mentions\": [\n {\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"owner_user_uuid\": \"<string>\",\n \"subject\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"created_at": 123,
"updated_at": 123
}Authorizations
Path Parameters
Body
application/json
⌘I