Update keyframe information

Required roles:

  • can_write_keyframes
patch/v1/collections/{collection_id}/keyframes/{keyframe_id}/

Request

Path parameters

collection_idstring required
keyframe_idstring required

Headers

App-IDstring required
Auth-Tokenstring required

Request body

date_createdstring date-time
date_modifiedstring date-time
filenamestring
formatstring nullable
is_custom_keyframeboolean
is_publicboolean
namestring
rotationinteger nullable
sizeinteger nullable
status'OPEN' | 'GROWING' | 'AWAITED' | 'CLOSED' | 'FAILED' | 'ARCHIVED' | 'MISSING' | 'REDISCOVERED' | 'DELETED'
type'KEYFRAME_MAP' | 'KEYFRAME' | 'POSTER' required
urlstring

Response

Returns a keyframe that was updated

collection_idstring uuid
date_createdstring date-time
date_modifiedstring date-time
filenamestring
formatstring nullable
idstring uuid
is_custom_keyframeboolean
is_publicboolean
namestring
rotationinteger nullable
sizeinteger nullable
status'OPEN' | 'GROWING' | 'AWAITED' | 'CLOSED' | 'FAILED' | 'ARCHIVED' | 'MISSING' | 'REDISCOVERED' | 'DELETED'
storage_idstring uuid
type'KEYFRAME_MAP' | 'KEYFRAME' | 'POSTER' required
urlstring

Changes

No recorded changes to this operation across all 1 revision of this API.