FileNotes

Create a file note

Create a file note associated to the requested property, owners/contacts. As a minimum a file note must be associated to either a property or a contact(s).

post/file-notes

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/file-notes
  • Auth: appAuth (a scheme the document does not define)

Headers

AgencyRefstring required

A GUID required in the header of all API requests that grants access to an agent's data

Request body

negotiatorIdstring nullable

[Optional] The unique identifier of a negotiator

propertyIdstring nullable

[Optional] The unique identifier of the property to associate to the file note

tenancyIdstring nullable

[Optional] The unique identifier of the tenancy to associate to the file note

ownerIdsstring[] nullable

[Optional] The unique identifiers (contact id) of the property owner(s) to associate to the file note

contactIdsstring[] nullable

[Optional] The unique identifiers of additional contact(s) to associate to the file note

titlestring nullable

[Optional] Title of the file note - not currently visible to users

notesstring nullable

[Required] The body/content of the file note

updateLastContactedDateboolean

When set to true the Last Contacted Date of Owners and Contacts will be updated

fileNoteType'Unspecified' | 'DetailsToVendor' | 'DetailsApproved' | 'FileNote' | 'PhoneCall' | 'EMail' nullable

[Optional] The type of file note to create

Response

Returns the unique identifier of the newly created file note

integer required

Changes

No recorded changes to this operation across all 1 revision of this API.