Playground

Playground

SLAPolicy

/api/v1/helpdesk/sla-policies

A service-level policy applied to tickets.

listgetcreateupdate

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidFK → UserUser id from the caller's JWT (sub).
updated_byuuidFK → UserUser id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidFK → UserUser id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
namestringHuman-readable name for this SLA policy.
descriptionstringOptional description of when and why this SLA policy applies.
applies_tojsonThe ticket types this SLA policy governs. A policy may apply to multiple ticket types.
prioritystringlow | normal | high | urgentThe ticket priority tier this policy applies to. Each priority level should have at most one active SLA policy per ticket type.
first_response_minutesnumberTarget number of minutes from ticket creation to first agent response. The SLA clock starts at ticket creation.
resolution_minutesnumberTarget number of minutes from ticket creation to full resolution.
business_hours_onlybooleanWhen true, the SLA clock pauses outside of the tenant's configured business hours and on public holidays.
statusstringnew | open | pending | on_hold | resolved | closed | cancelledWhether this policy is currently enforced. Inactive policies are retained for historical reference.
first_response_minsintegerTarget number of minutes from ticket creation to first agent response (e.g. 60).
resolution_minsintegerTarget number of minutes from ticket creation to full resolution (e.g. 480).

API

client.helpdesk.slaPolicies.*
Loading manifest…