Skip to content

Contents

FolioPin

Fields

id required Type: string
scope_kind required Type: "record" "folder"
scope_value required Type: string
reason_code required Type: string
reason_text optional Type: string null
pinned_by required Type: string
pinned_at_ms required Type: integer
ended_at_ms optional Type: integer null
ended_by optional Type: string null

Where you'll see it

Returned by POST/folio/pins Keep a record or folder out of colder storage
Returned by POST/folio/pins/{id}/end End a pin