appointments5

appointmentTypes5

assistantActions5

assistantInstances8

assistantTransferRules1

auth5

availabilities4

billingCharges5

billingCopays6

Broadcast Templates6

broadcastEvents4

broadcastFlows9

campaigns4

chatActivities4

chatActivitiesReasons5

chatAudits5

checklists7

checklistTemplates8

customWebStyles5

engagementEvents2

engagements8

engagementSettings5

estimates5

facilities5

feedbackResponses2

feedbackResponsesExternalReviewReplies2

feedbackResponsesExternalReviews2

feedbackResponsesPromoterHistories2

fileUploadRecords4

fileUploads5

groups5

insurancePayors7

insurances5

knowledgeBaseQuestionAnswers5

lumabotFlows12

lumabotFlowTemplates5

messages4

messageTemplatePartials5

offers5

outboundReferrals5

patientCreditCards5

patientFormPdfFilledDocuments5

patientFormPdfTemplates5

patientForms4

patientFormTemplates6

patientMessageTemplates5

patients7

providers5

providerSchedulingGroups5

queueManagerInstances1

recalls5

referrals6

reminders5

reports5

schedulers1

settings3

specialties14

squigglies1

systemAudits1

users5

waitlists5

engagements

Create an engagement

post/engagements

Request

Base URL
https://api.lumahealth.io/api/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/lumahealth/apis/rest-service/docs/engagements/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

_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 required

ID of the user this engagement is directed at.

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

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'

Response

Successful creation