Skip to main content
POST
Notify a workflow phase change

Authorizations

Authorization
string
header
required

Email address and password. A personal access token (pat_…) or session token (token-…) may also be sent in the password field, with any non-empty value as the username — a blank username short-circuits to a 401 before the token is read.

Path Parameters

id
string
required

Body

application/json
phase
string
required

The workflow phase the note belongs to. Must be non-empty and match the asset's current phase, or the request is rejected as a concurrent modification.

Minimum string length: 1
note
string

Note body. Trimmed; an empty value clears the note.

Response

Notification sent; returns the updated asset

_id
string
Example:

"507f1f77bcf86cd799439011"

studio
string
Example:

"507f1f77bcf86cd799439011"

project
string
Example:

"507f1f77bcf86cd799439011"

name
string
usage
object
importName
string
slug
string
type
string
thumbnail
string
Example:

"507f1f77bcf86cd799439011"

verified
boolean
previews
object[]
created
integer
mediaType
string
creative
boolean
$flags
any

Shape not inferred — the sampled response had no entries

$permissions
object
$embargo
boolean
$feedback
object
transcription
object
creator
string
Example:

"507f1f77bcf86cd799439011"

private
boolean
unorderable
boolean
aspectRatio
string
autosubIngest
string
Example:

"507f1f77bcf86cd799439011"

notifyUrl
string<uri>
Example:

"https://example.com/path/to/object"

embargo
integer