Skip to main content
PATCH
Update human-authored reference fields

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

referenceId
string<uuid>
required

Opaque reference identifier

Body

application/json
revision
integer
required
Required range: 0 <= x <= 9007199254740991
customTitle
string | null
Maximum string length: 500
notes
string
Maximum string length: 20000
tags
string[]
Maximum array length: 50
Required string length: 1 - 64

Response

Updated reference detail

id
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
workspaceId
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
canonicalContentId
string | null
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
sourceIngestionId
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
platform
enum<string>
required
Available options:
youtube
canonicalUrl
string | null
required
Required string length: 1 - 2048
state
enum<string>
required
Available options:
processing,
ready,
failed
mediaAvailability
enum<string>
required
Available options:
processing,
ready,
expired,
failed,
unavailable
failureCode
enum<string> | null
required
Available options:
invalid_input,
unauthenticated,
invalid_credential,
credential_conflict,
forbidden,
policy_blocked,
route_disabled,
route_degraded,
not_found,
bootstrap_conflict,
last_owner_conflict,
revision_conflict,
idempotency_conflict,
unavailable_private,
unavailable_restricted,
unavailable_removed,
unsupported_object,
unsupported_media,
limit_exceeded,
rate_limited,
source_changed,
network_timeout,
network_transport,
media_invalid,
storage_unavailable,
retry_exhausted,
internal_error
retryable
boolean | null
required
createdAt
string
required
Pattern: ^\d{4}-(0[1-9]|1[0-2])-([0-2]\d|3[01])T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,9})?(?:Z|[+-](?:[01]\d|2[0-3]):[0-5]\d)$
updatedAt
string
required
Pattern: ^\d{4}-(0[1-9]|1[0-2])-([0-2]\d|3[01])T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,9})?(?:Z|[+-](?:[01]\d|2[0-3]):[0-5]\d)$
revision
integer
required
Required range: 0 <= x <= 9007199254740991
sourceObserved
object | null
required
humanAuthored
object
required
primaryMediaId
string | null
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
posterMediaId
string | null
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
machineDerived
object | null
required
provenance
object | null
required
mediaHold
object | null
required
mediaExpiredAt
string | null
required
Pattern: ^\d{4}-(0[1-9]|1[0-2])-([0-2]\d|3[01])T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,9})?(?:Z|[+-](?:[01]\d|2[0-3]):[0-5]\d)$