Skip to content

Set the default Note template

PUT
/api/v1/notes/templates/default
curl --request PUT \
--url https://example.com/api/v1/notes/templates/default \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "folder": "example", "template_id": "example" }'

Requires a signed-in User with the data scope. It sets or clears the template used for new Notes. It returns 400 for invalid input or 404 when the template is missing. Route: /api/v1/notes/templates/default. Inputs: . Do not automatically replay this operation after an uncertain result.

Media typeapplication/json
object
folder

The only destination for Notes created by calternal is Notes/.

string | null
template_id
string | null
Examplegenerated
{
"folder": "example",
"template_id": "example"
}
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
"error": {
"code": "bad_request"
}
}
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
"error": {
"code": "bad_request"
}
}