API REFERENCE · SCHEMA
Archive
Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.
Retained record for archive category holds. Keys retain their stored snake_case spelling. Nullable columns are included with null values. Expired records use ArchiveExpiredRecord instead; holdings can omit expired reason text.
idRequired- string
Format: uuid.
organization_idRequired- string
environmentRequired- string
case_idRequired- string
Format: uuid.
screening_idsRequired- string[]
screening_ids item fields
Each array item: string.
reasonOptional- string
actor_idRequired- string
until_atRequired- string or null
May be null.
until_at fields and rules
Allowed alternatives
- string
Format: date-time.
- null
May be null.
- string
released_atRequired- string or null
May be null.
released_at fields and rules
Allowed alternatives
- string
Format: date-time.
- null
May be null.
- string
released_byRequired- string or null
May be null.
released_by fields and rules
Allowed alternatives
- string
- null
May be null.
release_reasonOptional- string or null
May be null.
release_reason fields and rules
Allowed alternatives
- string
- null
May be null.
created_atRequired- string
Format: date-time.
Use ArchiveHold in a workflow
Used by
Open an operation for its complete request or response example, including any outer JSON object that wraps these fields.