Raw schema
{
"type": "object",
"properties": {
"ClientId": {
"description": "Update this existing client.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"Name": {
"description": "Full name.",
"type": "string"
},
"FirstName": {
"type": "string"
},
"LastName": {
"type": "string"
},
"MiddleName": {
"type": "string"
},
"Email": {
"type": "string"
},
"Phone": {
"type": "string"
},
"HomePhone": {
"type": "string"
},
"WorkPhone": {
"type": "string"
},
"MobilePhone": {
"type": "string"
},
"DateOfBirth": {
"description": "Unix timestamp in ms.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"Gender": {
"type": "string"
},
"MaritalStatus": {
"type": "string"
},
"Archived": {
"type": "boolean"
},
"Address": {
"description": "Full address, or send the components below instead.",
"type": "string"
},
"UnitNumber": {
"type": "string"
},
"StreetAddress": {
"type": "string"
},
"City": {
"type": "string"
},
"StateShort": {
"type": "string"
},
"Country": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"PractitionerId": {
"description": "Assign to this practitioner.",
"type": "string"
},
"AdditionalInformation": {
"type": "string"
},
"PrimaryInsuranceCompany": {
"type": "string"
},
"PrimaryInsurancePolicyNumber": {
"type": "string"
},
"PrimaryInsuranceGroupNumber": {
"type": "string"
},
"PrimaryInsuranceHolderName": {
"type": "string"
},
"PrimaryInsuranceRelationship": {
"type": "string"
},
"PrimaryInsuranceHolderDateOfBirth": {
"description": "Unix timestamp in ms.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"SecondaryInsuranceCompany": {
"type": "string"
},
"SecondaryInsurancePolicyNumber": {
"type": "string"
},
"SecondaryInsuranceGroupNumber": {
"type": "string"
},
"SecondaryInsuranceHolderName": {
"type": "string"
},
"SecondaryInsuranceRelationship": {
"type": "string"
},
"SecondaryInsuranceHolderDateOfBirth": {
"description": "Unix timestamp in ms.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"ExternalClientId": {
"type": "string"
},
"CustomFields": {
"description": "Custom field values (FieldId + Value).",
"type": "array",
"items": {
"type": "object",
"properties": {
"FieldId": {
"type": "string",
"minLength": 1,
"description": "The custom field's id."
},
"Value": {
"type": "string",
"description": "The value to store."
},
"Text": {
"description": "The field's label (optional).",
"type": "string"
}
},
"required": [
"FieldId",
"Value"
]
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}