latestSwagger 2.02026-08-10143234301.7 KB

dc2736850e42

Rest

Create a new client profile

post/users/client

Headers

Authorizationstring required

Bearer {user_token}

SiteIdinteger required

Site ID

Request body

UserIdstring

The User ID of the authenticated client OR their dependent. When provided, the client profile will be created for this user.

ExternalIdstring

RSSID

MiddleNamestring

Middle Name

HomePhonestring

Home Phone Number

WorkPhonestring

Work Phone Number

MobilePhonestring

Mobile Phone Number

Addressstring

Client Stree Address

Address2string

Client Street Address Line 2

Citystring

City for Client Address

Statestring

State for Client Address

Countrystring

Country for Client Address

PostalCodestring

Client Address Zip Code

Genderstring

Gender

BirthDatestring date-time

Birthdate

ReferredBystring

Name of client who referred this client

EmergencyContactInfoNamestring

Name of Emergency contact

EmergencyContactInfoRelationshipstring

Emergency contact's relationship to this client

EmergencyContactInfoPhonestring

Phone number of emergency contact

EmergencyContactInfoEmailstring

Email of emergency contact

Testboolean

When true, the client will not actually be created in the database. Defaults to false.

Response

Created

Idinteger

ClientId aka UniqueId

ExternalIdstring

RSSID

FirstNamestring

First Name

LastNamestring

Last Name

MiddleNamestring

Middle Name

Emailstring

Email

HomePhonestring

Home Phone Number

WorkPhonestring

Work Phone Number

MobilePhonestring

Mobile Phone Number

Addressstring

Client Stree Address

Address2string

Client Street Address Line 2

Citystring

City for Client Address

Statestring

State for Client Address

Countrystring

Country for Client Address

PostalCodestring

Client Address Zip Code

Genderstring

Gender

BirthDatestring date-time

Birthdate

ReferredBystring

Name of client who referred this client

EmergencyContactInfoNamestring

Name of Emergency contact

EmergencyContactInfoRelationshipstring

Emergency contact's relationship to this client

EmergencyContactInfoPhonestring

Phone number of emergency contact

EmergencyContactInfoEmailstring

Email of emergency contact