Contacts

Create Contact

post/contacts

Request

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

Headers

AgencyRefstring required

Request body

negotiatorIdstring nullable

The unique identifier of the negotiator

branchIdstring required

The Contact's BranchId.

positionstring nullable

The position of the contact, defined as the Id for this AgencyRef chosen from /parameters/client-positions

intentionstring nullable

The intention of the contact, defined as the Id for this AgencyRef chosen from /parameters/client-intentions

disposalstring nullable

The disposal of the contact, defined as the Id for this AgencyRef chosen from /parameters/client-disposal-status

notesstring nullable

The notes for the contact

companyNamestring nullable

The company name associated with the contact

category'Unknown' | 'Client' | 'ContactRelationship'

The contact's category type

potentialVendorboolean nullable

Indicates whether the contact is a potential vendor.

potentialLandlordboolean nullable

Indicates whether the contact is a potential landlord.

Example request

{
  "negotiatorId": "1234",
  "branchId": "1234",
  "address": {
    "subDwelling": "The Flats",
    "nameNumber": "12",
    "street": "Fulham Road",
    "locality": "Fulham",
    "town": "London",
    "county": "Greater London",
    "postcode": "SW10 0BF",
    "countryCode": "GB",
    "uprn": "100123456789"
  },
  "people": [
    {
      "title": "Ms",
      "forename": "Jane",
      "surname": "Doe",
      "phoneNumbers": [
        {
          "type": "Mobile",
          "number": "+44 7 267 789 134",
          "description": "Evenings and weekends only!"
        }
      ],
      "emailAddresses": [
        {
          "address": "john.doe@business.com"
        }
      ]
    }
  ],
  "category": "Client, ContactRelationship",
  "potentialVendor": true,
  "potentialLandlord": true
}

Response

Contact created.

idstring nullable

The unique identifier for the resource.

category'Unknown' | 'Client' | 'Solicitor' | 'BuildingSociety' | 'Bank' | 'Publication' | 'EstateAgent' | 'ManagingAgent' | 'Developer' | 'Builder' | 'Utility' | 'Service' | 'PreviousClient' | 'Miscellaneous' | 'FinancialAdvisor' | 'Maintenance' | 'OnSiteSales' | 'ExternalPrinter' | 'OtherCategory1' | 'EstateAgentLocal' | 'Surveyor' | 'Supplier' | 'Accountant'
notesstring nullable

The notes for the contact

archivedboolean

The archived status of the contact.

companyNamestring nullable

The company name associated with the contact.

potentialVendorboolean

Indicates whether the contact has been flagged as a potential vendor.

potentialLandlordboolean

Indicates whether the contact has been flagged as a potential landlord.

modifiedDatestring date-time

When the contact was last modified.

Example response

{
  "people": [
    {
      "title": "Ms",
      "forename": "Jane",
      "surname": "Doe",
      "phoneNumbers": [
        {
          "preferenceOrder": 1,
          "type": "Mobile",
          "number": "01234567891",
          "description": "John's mobile"
        }
      ],
      "emailAddresses": [
        {
          "preferenceOrder": 2,
          "type": "Business",
          "address": "john.doe@business.com"
        }
      ]
    }
  ],
  "modifiedDate": "2017-12-25T15:03:30.0000000+00:00"
}

Changes

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