Appointments

Create a general appointment.

Creates an appointment with the requested contacts and properties for the given negotiators. Required scope: alto/write:appointments_general

post/appointments/general

Request

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

Headers

AgencyRefstring required

Request body

negotiatorIdsinteger[] required

Required: The unique identifer of the negotiator(s)

branchIdinteger nullable

Optional: The branch in which to record the appointment diary event. When omitted, defaults to the first negotiator's default branch.

contactIdsinteger[] nullable

Optional: The unique identifer of the applicant(s)

propertyIdsinteger[] nullable

Optional: The unique identifer of the property(s)

urgentboolean

Optional: Set the Urgent flag for the appointment being created. If ommitted this will default to false.

startDatestring date-time required

Required: The start date and time in ISO 8601 format of the appointment being created. Interpreted as UK local diary time: a value with a UTC marker (a trailing Z) or an explicit offset is converted to UK local time (Europe/London); a plain local value with no offset is taken as-is.

endDatestring date-time required

Required: The end date and time in ISO 8601 format of the appointment being created. Interpreted as UK local diary time: a value with a UTC marker (a trailing Z) or an explicit offset is converted to UK local time (Europe/London); a plain local value with no offset is taken as-is.

subTypeIdinteger required

Required: The sub type of the appointment being created.

locationstring nullable

Optional: The location where the appointment being created will be held.

notesstring nullable

Optional: Additional notes to accompany the appointment being created.

Example request

{
  "negotiatorIds": [
    356773,
    356912
  ],
  "branchId": 12345,
  "contactIds": [
    7891011,
    7891025
  ],
  "propertyIds": [
    1244589,
    1244676
  ],
  "startDate": "2023-01-01T10:15:00.0000000+00:00",
  "endDate": "2023-01-01T10:30:00.0000000+00:00",
  "subTypeId": 123,
  "location": "Meeting room A",
  "notes": "Here are some optional notes"
}

Response

Returns an object containing the newly created appointment's unique identifier

appointmentIdinteger

The unique identifier of the viewing appointment that has been created

Example response

{
  "appointmentId": 123456
}

Changes

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