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

users

Create user

Changed on Oct 17, 2026

post/users

Request

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

Request body

safeIdstring

safeId

namestring required

Full name

firstnamestring

First name

lastnamestring

Last name

middlenamestring

Middle name

alternativeNamestring

Alternative name

displayPhonestring

Phone number displayed in staff profile. Not used for communication purposes.

displayStatus'active' | 'pending' | 'suspended'

Account status. Informative field only, not used for access control.

emailstring required

User's e-mail address in lowercase.

rolesstring[]

User's roles, used for access control.

organizationstring

The ID of the organization controling this root user account.

doNotContactboolean required

Indicates if the user has requested not to be contacted anymore.

doNotContactMessagestring

The ID of the message where the user requested not to be contacted anymore.

groupsstring[]

List of group IDs to which this user belongs.

stripeCustomerIdstring

Customer ID from stripe for this account

stripeSubscriptionIdstring

Stripe subscription ID

salesforceIdstring

Salesforce Account ID for this account

activenumber required

Indicates if a user is active and able to log into the system or not.

languagestring

User's preferred language.

addressstring

User's address.

citystring

User's city.

statestring

User's state.

countrystring

User's country

postcodestring

User's postal code.

gender'male' | 'female' | 'unknown' | 'nonbinary' required

User's gender.

avatarstring

The ID of a FileUpload containing the profile picture of the user.

directMessagingEmailstring

E-mail for direct communication with the user.

websitestring

User's website.

type'staff' | 'doctor' | 'guest' required

type

allowedIpsstring[]

allowedIps

Response

Successful creation

_idstring

Luma's internal ID of an object.

safeIdstring

safeId

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.

namestring