Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Paste your API key as the CMS showed it: fsk_<site>_<key id>_<secret> (issued under API Keys). ApiKey in front of it works too. Leave it empty to read as the public.

Scopes

content:images:write

Path Parameters

_id
string
required

Computed document ID (can optionally include mode and locale, e.g., id:en:published)

Pattern: ^\S+$
Example:

"ckitdo5oq004pu69kr6oxo6fr:en:published"

Query Parameters

aposMode
enum<string>
default:published

published (the default) or draft. Drafts need a credential that may see them: an API key with the type’s write scope (content:<type>:write), or a signed-in editor. The public and a key with only the read scope get 403.

Available options:
draft,
published
aposLocale
string

The locale to read or write, e.g. en (default: the site’s default locale).

Example:

"fr"

Body

application/json

Built-in image tag piece type for organizing images

title
string
required

Tag name

Example:

"Hero Images"

slug
string
required

URL-friendly tag name

Example:

"hero-images"

archived
boolean | null
default:false

In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.

copyOfId
string | null

The _id of the piece/page that was copied to create this document (only present if created via _copyingId)

Example:

"ckhdscx5900054z9k88uqs16w:en:published"

Response

Image tag updated successfully

Built-in image tag piece type for organizing images

_id
string
required
read-only
Example:

"clx1234567890abcdef"

title
string
required

Tag name

Example:

"Hero Images"

slug
string
required

URL-friendly tag name

Example:

"hero-images"

type
string
required
read-only
Example:

"@apostrophecms/image-tag"

createdAt
string<date-time>
required
read-only
updatedAt
string<date-time>
required
read-only
archived
boolean | null
default:false

In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.

copyOfId
string | null

The _id of the piece/page that was copied to create this document (only present if created via _copyingId)

Example:

"ckhdscx5900054z9k88uqs16w:en:published"

aposShareKey
string | null
read-only

The draft’s preview share key, while its share link is on: the link is the draft’s _url with aposShareKey and aposShareId (the draft’s _id) in its query. Absent otherwise, and on published documents.

Example:

"k3v9x2m7q1z8w4p6"