Sign in
latestOpenAPI 3.0.02026-08-232861531.0 MB

d3c75c2a2f1d

engagements

Perform an operation on an engagement

Generic operation dispatcher for an in-flight engagement, used to transfer or end a call, request a callback, send an SMS, hand off to the hub, transfer channels, or push a new EngagementEvent onto the engagement.

post/engagements/{engagement}/operations/{operation}

Path parameters

engagementstring required

Engagement's unique identifier in Luma's database.

operation'transferCall' | 'end' | 'callMe' | 'sendSms' | 'sendToHub' | 'transferChannel' | 'pushEvent' required

The operation to perform.

Request body

operationDataobject

Data for the operation being performed. For pushEvent, this is the EngagementEvent payload to append.

Response

The updated engagement

_idstring

Luma's internal ID of an object.

userstring

The ID of the root account user.

deleted0 | 1

Flag for logical deletion where 1 means deleted.

createdBystring

The ID of the user who created this object.

updatedBystring

The ID of the user who updated this object.

createdAtstring date-time

The date/time when this object was created.

updatedAtstring date-time

The date/time when this object was updated.

recipientstring

ID of the user this engagement is directed at.

recipientType'doctor' | 'staff' | 'patient' | 'system'

The kind of user recipient is.

patientstring

DEPRECATED. Use recipient and recipientType instead.

expiresAtstring date-time
topicstring
agentsstring[]

IDs of the AI agents involved in this engagement.

mainAgentstring

ID of the primary AI agent driving this engagement.

engagementSettingstring

ID of the EngagementSetting (voice/language preset) used for this engagement.

contextobject

Initial context provided to the engagement, used for outbound flows. Keys must correspond to AgentContextVariable names, and values must conform to that variable's schema.

completedAtstring date-time
type'conversational' | 'other'
status'in-progress' | 'failed' | 'success' | 'escalation_required' | 'idle'

Lifecycle status of the engagement. Transitions from in-progress to success, failed, or escalation_required.

statusReason'expired' | 'systemic_failure'