Sign in
Episodes

Create episode

Create a new episode for case/ticket/thread tracking

post/api/v1/episodes

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Headers

X-API-Keystring nullable

Request body

scope_typestring

Visibility scope: personal, team, department, division, organization

scope_idstring nullable

ID of team/department/division if scoped

owner_user_idstring nullable

User who owns/initiated this episode

episode_typestring nullable

Type: support_case, research_thread, legal_case, customer_incident, etc.

titlestring nullable

Episode title/subject

tagsstring[] nullable

Tags for categorization/filtering

entitiesobject nullable

Extracted entities (customer_id, device_id, account_number, etc.)

Response

Successful Response

idstring required
organization_idstring required
scope_typestring required
scope_idstring nullable required
owner_user_idstring nullable required
episode_typestring nullable required
statusstring required
titlestring nullable required
summarystring nullable required
started_atstring date-time required
last_event_atstring date-time required
resolved_atstring date-time nullable required
tagsstring[] nullable required
entitiesobject nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.