Appointment Custom Fields

The Appointment Custom fields feature are customized practice specific preferences that allows adding customfield values to appointments.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Update appointment-level custom fields

PUT
/v1/{practiceid}/appointments/{appointmentid}/customfields
Modify the customfield data for a specific appointment
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
appointmentid integer appointmentid
Content-Type string Content type of the payload

❙ Request Body

Expand all
customfields array A JSON representation of any updates to custom fields. The contents of this should match the custom fields output with /appointments/customfields of course, any updates. Validation should happen based on the structure given in the /customfields/ call; this means that the values submitted in a select list should be a proper option ID, that number fields are restricted to numbers, and date fields restricted to dates (mm/dd/yyyy).

Output Parameters

Expand all
disallowedcount integer The number of fields not updated because the field is not allowed to be updated.
success string Indicates that this call was successful.
updatedcount integer The number of fields updated.
Example Code

Get the list of appointment custom fields

GET
/v1/{practiceid}/appointments/customfields
Retrieve the list of customfields configured in the system
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
casesensitiveyn string Is this field case sensitive?
customfieldid integer The custom field ID.
disallowupdateyn string Can this field be updated?
length integer Maximum length of this field.
name string The name of this custom field.
ordering integer The ordering in which this field is displayed.
searchableyn string If true will allow it to be searchable from the search box in the main page.
selectlist array An array of options, each one containing selectid and a selectvalue.
selectyn string Is this field a select list (and thus should have a "selectlist" as well).
type string One of "TEXT", "DATE", "NUMBER", or "REFERRINGPROVIDER".
Example Code