Skip to content
Exhale

Rename a tag

POST
/api/v1/tags/rename
curl --request POST \
  --url http://127.0.0.1:8484/api/v1/tags/rename \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "dryRun": true, "tag": "example", "to": "example" }'

Renames a tag on every subscription that has it; if one already has the new name, they merge. The tags in use are in get_household.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
dryRun
boolean
tag
required
string
to
required
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
auditIds
required
Array<string> | null
changed
required
integer format: int64
dryRun
boolean
items
required
Array<object> | null
object
changes
required
Array<object> | null
object
field
required
string
Allowed values: category paymentMethod tags status deleted
from
required
string
to
required
string
id
required
string
name
required
string

Example 

{
  "$schema": "https://example.com/api/schemas/BulkResult.json",
  "items": [
    {
      "changes": [
        {
          "field": "category"
        }
      ]
    }
  ]
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "$schema": "https://example.com/api/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}