v1

latestOpenAPI 3.0.32026-07-24411867.5 KB

Create new user and add to enitty

This endpoint creates a new user and associates to the passed in entity

post/entities/{entity_id}/users

Path parameters

entity_idstring required

Request body

fnamestring required

First name of the new user. Whitespace is stripped.

lnamestring required

Last name of the new user. Whitespace is stripped.

assigned_advisor_idinteger required

ID of a firm user to assign as the client's advisor. Must belong to the authenticated firm.

phone_numberstring

Personal phone number.

work_phone_numberstring

Work phone number.

work_phone_extensionstring

Work phone extension.

preferred_contact_methodstring

Preferred contact method (e.g. "email", "sms").

time_zonestring

IANA time zone name. Defaults to the firm's time zone if omitted.

external_user_idstring

Caller-supplied external identifier for the user.

Response