Skip to main content
Sync external Case events

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

case_id
string
required

ID of the case to sync external case events for. Accepts either the case UUID (the id field on a case) or the readable identifier (the readable_id field, e.g. CASE-123).

Required string length: 1 - 64
Pattern: ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$
Example:

"3f166e9f-3c88-4af2-b52e-138f339dab3e"

Response

Response returned after syncing external case events.

syncRegistered
boolean
required

Indicates whether the sync was successfully registered