Retitle a Note
POST
/api/v1/notes/{id}/retitle
const url = 'https://example.com/api/v1/notes/example/retitle';const options = { method: 'POST', headers: { 'If-Match': 'example', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"title":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/notes/example/retitle \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'If-Match: example' \ --data '{ "title": "example" }'Requires a signed-in User with edit access to the Note and its current ETag in If-Match. It keeps the Note ID when it changes the title. It returns 400 for an invalid title, 409 when the name is already used, 412 when the Note changed, or 428 when If-Match is missing. Route: /api/v1/notes/{id}/retitle. Inputs: id, If-Match. Do not automatically replay this operation after an uncertain result.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Header Parameters
Section titled “Header Parameters”If-Match
required
string
Current Note ETag
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
title
required
string
Examplegenerated
{ "title": "example"}Responses
Section titled “Responses”Media typeapplication/json
object
body
required
string
canvas
Validated render data for Canvas; an invalid imported file has no scene.
etag
required
string
id
required
string
path
required
string
properties
required
title
required
string
Examplegenerated
{ "body": "example", "canvas": "example", "etag": "example", "id": "example", "path": "example", "properties": "example", "title": "example"}