Fire action by ID
Fires a workflow action, specified by identifier, on a target contentlet.
Returns a map of the resultant contentlet, with an additional AUTO_ASSIGN_WORKFLOW property, which can be referenced by delegate services that handle automatically assigning workflow schemes to content with none.
Use this endpoint to fire actions that are not represented as SystemAction tokens (NEW, EDIT, PUBLISH, etc.). The two most common are Move and Copy on the System Workflow scheme.
Move action — relocates a contentlet to a new folder/host. Request body shape (note: pathToMove is a sibling of contentlet, not nested inside it):
{
"contentlet": { "identifier": "<contentlet-identifier>" },
"pathToMove": "//<siteHost>/<folderPath>"
}
Alternative shapes (contentlet.host+contentlet.folder, contentlet.hostFolder, path instead of pathToMove) all return 400 "The host path is not valid: null".
Copy action — clones a contentlet. Fire with ?identifier=<source-id> and an empty body (or {"contentlet": {"identifier": "<source-id>"}}). The Copy action id on the default System Workflow scheme is 963f6a04-5320-42e7-ab74-6d876d199946; retrieve it for other environments via GET /api/v1/workflow/schemes/{schemeId}/actions. ⚠️ The response entity returns the source contentlet, not the newly-created copy — locate the copy via a follow-up POST /api/content/_search ordered by modDate DESC. The copy lands in SYSTEM_HOST / SYSTEM_FOLDER; destination hints (pathToMove, host, folder, hostFolder) are silently ignored. Fire the Move action afterwards to relocate.
When chaining workflow actions or reading state back immediately after firing, pass indexPolicy=WAIT_FOR on each call. The default DEFER is asynchronous and can return stale index reads for several seconds, which can mimic server-side state bugs. For isolated one-off fires where nothing reads the result, leave the default.
Path parameters
Identifier of a workflow action.
Example value: b9d89c80-3d88-4311-8365-187323c96436 (Default system workflow "Publish" action)
Query parameters
Inode of the target content.
Identifier of target content.
Determines how target content is indexed.
| Value | Description |
|---|---|
| DEFER | Content will be indexed asynchronously, outside of the current process. Valid content will finish the method in process and be returned before the content becomes visible in the index. This is the default index policy; it is resource-friendly and well-suited to batch processing. |
| WAIT_FOR | The API call will not return from the content check process until the content has been indexed. Ensures content is promptly available for searching. |
| FORCE | Forces Elasticsearch to index the content immediately.<br>Caution: Using this value may cause system performance issues; it is not recommended for general use, though may be useful for testing purposes. |
Language version of target content.
Request body
Response
Fired action successfully
Changes
No recorded changes to this endpoint across all 1 revision of this API.