--- title: "Create Contact" method: POST path: "/contacts" tags: ["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 - `AgencyRef` string, required ## Request body - AltoContactsApiModelsRequestsPostContactRequest - `negotiatorId` string, nullable: The unique identifier of the negotiator - `branchId` string, required: The Contact's BranchId. - `address` AltoContactsApiModelsRequestsAddress - `subDwelling` string, nullable: The sub-dwelling of the address, such as a flat or apartment number. - `nameNumber` string, nullable: The name or number of the building or property. - `street` string, nullable: The name of the street. - `locality` string, nullable: The locality, such as a village or neighborhood. - `town` string, nullable: The town or city of the address. - `county` string, nullable: The county or region of the address. - `postcode` string, nullable: The postal code of the address. - `countryCode` string, nullable: The country code of the address. Default if not set: GB - `uprn` string, nullable: The Unique Property Reference Number (UPRN) for the address. This is an optional field for backward compatibility. - `people` AltoContactsApiModelsRequestsPerson[], required: The Person(s) on the Contact. Each Contact must have at least one Person but no more than two People. - `title` string, nullable: The formal title of the Person. - `forename` string, nullable: The first or given name of the Person. - `surname` string, required: The surname of the Person. - `phoneNumbers` AltoContactsApiModelsRequestsPhone[], nullable: A list of the Person's phone numbers. - `type` 'Unspecified' | 'Home' | 'Business' | 'Mobile' | 'Fax' | 'Work' | 'ISDN': The type of phone number. Default if not set: "Home". - `number` string, required: The telephone number for the Person. - `description` string, nullable: The description of the telephone number. - `emailAddresses` AltoContactsApiModelsRequestsEmailAddress[], nullable: A list of the Person's email addresses - `address` string, email, required: The email address. - `lead` AltoContactsApiModelsRequestsLead - `source` string, required: The Id for this AgencyRef chosen from /parameters/lead-sources - `id` string, nullable: The numeric Id of the lead record that is being converted into a contact - `position` string, nullable: The position of the contact, defined as the Id for this AgencyRef chosen from /parameters/client-positions - `intention` string, nullable: The intention of the contact, defined as the Id for this AgencyRef chosen from /parameters/client-intentions - `disposal` string, nullable: The disposal of the contact, defined as the Id for this AgencyRef chosen from /parameters/client-disposal-status - `notes` string, nullable: The notes for the contact - `companyName` string, nullable: The company name associated with the contact - `category` 'Unknown' | 'Client' | 'ContactRelationship': The contact's category type - `potentialVendor` boolean, nullable: Indicates whether the contact is a potential vendor. - `potentialLandlord` boolean, nullable: Indicates whether the contact is a potential landlord. ## Response `201` Contact created. - AltoContactsApiModelsResponsesContact - `id` string, nullable: The unique identifier for the resource. - `links` AltoApiMaterialHateoasLink[], nullable: Links to related entities. - `href` string, nullable - `rel` string, nullable - `address` AltoServicesSDKModelsAddress - `subDwelling` string, nullable - `nameNumber` string, nullable - `street` string, nullable - `locality` string, nullable - `town` string, nullable - `county` string, nullable - `postcode` string, nullable - `countryCode` string, nullable - `uprn` string, nullable - `branch` AltoContactsCoreModelsDomainBranch - `id` string, nullable - `people` AltoContactsApiModelsResponsesPerson[], nullable - `id` string, nullable: The unique identifier for the resource. - `links` AltoApiMaterialHateoasLink[], nullable: Links to related entities. - `href` string, nullable - `rel` string, nullable - `title` string, nullable: The formal title of the Person. - `forename` string, nullable: The first or given name of the Person. - `surname` string, nullable: The surname of the Person. - `phoneNumbers` AltoContactsApiModelsResponsesPhone[], nullable - `preferenceOrder` integer: The numerical order in which phone numbers are to be selected. - `type` 'Unspecified' | 'Home' | 'Business' | 'Mobile' | 'Fax' | 'Work' | 'ISDN': The type of phone number. - `number` string, nullable: The telephone number for the Contact. - `description` string, nullable: The description of the phone number - `emailAddresses` AltoContactsApiModelsResponsesEmailAddress[], nullable - `preferenceOrder` integer: The numerical order in which email addresses are to be selected. - `type` 'Unknown' | 'Personal' | 'Business': The type of email address. - `address` string, nullable: The email address. - `category` 'Unknown' | 'Client' | 'Solicitor' | 'BuildingSociety' | 'Bank' | 'Publication' | 'EstateAgent' | 'ManagingAgent' | 'Developer' | 'Builder' | 'Utility' | 'Service' | 'PreviousClient' | 'Miscellaneous' | 'FinancialAdvisor' | 'Maintenance' | 'OnSiteSales' | 'ExternalPrinter' | 'OtherCategory1' | 'EstateAgentLocal' | 'Surveyor' | 'Supplier' | 'Accountant' - `lead` AltoContactsApiModelsResponsesLead - `source` AltoContactsApiModelsResponsesParameterValue - `code` string, nullable - `name` string, nullable - `id` integer, nullable - `position` AltoContactsApiModelsResponsesParameterValue - `code` string, nullable - `name` string, nullable - `intention` AltoContactsApiModelsResponsesParameterValue - `code` string, nullable - `name` string, nullable - `disposal` AltoContactsApiModelsResponsesParameterValue - `code` string, nullable - `name` string, nullable - `notes` string, nullable: The notes for the contact - `archived` boolean: The archived status of the contact. - `companyName` string, nullable: The company name associated with the contact. - `potentialVendor` boolean: Indicates whether the contact has been flagged as a potential vendor. - `potentialLandlord` boolean: Indicates whether the contact has been flagged as a potential landlord. - `applicantRequirements` AltoContactsApiModelsResponsesApplicantRequirement[], nullable - `id` string, nullable: The unique identifier for the resource. - `links` AltoApiMaterialHateoasLink[], nullable: Links to related entities. - `href` string, nullable - `rel` string, nullable - `profileIntention` string, nullable - `isNewBuild` boolean, nullable - `priceFrom` number, double, nullable - `priceTo` number, double, nullable - `bedsMin` integer, nullable - `isActiveProfile` boolean - `rentalIntention` AltoContactsApiModelsResponsesRentalIntention - `priceQualifier` 'Unknown' | 'Weekly' | 'Monthly' | 'Quarterly' | 'Yearly' | 'AdHoc' | 'Daily' | 'Fortnightly' | 'FourWeekly' | 'MonthlyOnLastDay' | 'QuarterlyOnQuarterDays' | 'HalfYearly' | 'HalfYearlyOnQuarterDays' - `furnishing` 'Unspecified' | 'Unfurnished' | 'PartFurnished' | 'Furnished' | 'FurnishedOrUnfurnished', nullable - `tenureType` 'Unspecified' | 'Freehold' | 'Leasehold' | 'LeaseholdWithShareOfFreehold' | 'FlyingFreehold' | 'Commonhold' | 'ShareOfFreehold', nullable - `notes` string, nullable - `modifiedDate` string, date-time: When the contact was last modified. ## Other responses - `400`: Invalid request. - `409`: Duplicate contacts found. Check Location response headers for URI. --- [API](https://skmtc.dev/alto/apis/alto-api.md) - [All operations](https://skmtc.dev/alto/apis/alto-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alto/apis/alto-api/revisions/1b729d9b15a8?raw)