Contacts are individuals associated with a Customer. They can be internal employees or external individuals.
You can associate Contacts with Bookings to track their booking history.
You can track contact information for each Contact, creating a simple address book and auto-filling Offers and Invoices with relevant data.
Create a Contact
Creates a Contact based on the provided fields.
Request Body
orgIdstring · uuid · requiredThe id of the
Organizationthat owns thisContact.customerIdstring · uuid · requiredThe id of the
Customerthat owns thisContact.fullNamestring · requiredThe full name of the
Contact.
titlestringThe job title of the
Contact.emailstring · emailThe email address of the
Contact.phonestringThe phone number of the
Contact.detailsstring · htmlSupports basic HTML tags and formatting.
Responses
The newly created Contact.
contactobject · required
Update a Contact
Updates the specified Contact by setting the values of the fields passed. Any fields not provided will remain unchanged. By design you cannot change a Contact's id, nor the Customer it is associated with.
path Parameters
contactIdstring · requiredThe id of the
Contact.
Request Body
fullNamestringThe full name of the
Contact.titlestringThe job title of the
Contact.emailstring · emailThe email address of the
Contact.phonestringThe phone number of the
Contact.detailsstring · htmlSupports basic HTML tags and formatting.
Responses
The updated Contact
contactobject · required