Skip to content
calternal docs

Rename Tag

POST
/api/v1/tags/rename
curl --request POST \
  --url https://example.com/api/v1/tags/rename \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "confirmed": true, "new_tag": "example", "old_tag": "example" }'

Rename or merge a Tag with a durable progress and Undo receipt. Confirm merges of more than 20 items. Route: /api/v1/tags/rename. Inputs: . Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Legacy rename and preview arguments retain their names; optional consent follows the durable merge rule for every adapter (#1110).

object
confirmed
boolean
new_tag
required
string
old_tag
required
string
Examplegenerated
{
  "confirmed": true,
  "new_tag": "example",
  "old_tag": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Source text stays private in Home journals; clients receive only progress.

object
can_undo
required
boolean
conflicts
required
integer
current
integer | null format: int64
id
required
string
state
required
string
total
integer | null format: int64
Examplegenerated
{
  "can_undo": true,
  "conflicts": 1,
  "current": 1,
  "id": "example",
  "state": "example",
  "total": 1
}

400

Section titled “400”
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"
  }
}

409

Section titled “409”
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"
  }
}