Skip to main content
POST
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

Body

application/json

The images and what to do with the tag.

_ids
string[]
required

The documents’ _ids: a full id names its own locale and mode (a draft’s …:en:draft, a published …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).

operation
enum<string>
required

create: make the tag (title; an existing tag with the same slug is reused) and add it; add / remove: the tag named by slug.

Available options:
create,
add,
remove
title
string

The new tag’s title (create).

slug
string

The tag’s slug (add, remove).

Response

The job started.

A background job started: the work runs after this answer, so it says the job began, not that it finished. Each document is checked against the caller’s permissions as the job reaches it; one it may not touch is skipped, not an error. The management API follows a job (GET /@apostrophecms/job/{jobId}: its progress, what failed, when it ended); an API key can’t yet, so read the documents themselves to see the result.

jobId
string
required

The job’s id, for the management API’s job routes (read it, cancel it).