---
title: "Update a contact"
method: PUT
path: "/contacts/{id}"
tags: ["Contacts"]
---

# Update a contact

`PUT /contacts/{id}`

Updates a specified contact.

## Path parameters

- `id` string, uuid, required

## Request body

- ContactDto
  - `externalSystemId` string, nullable — External system id for the contact.
  - `person` PersonDto
    - `title` string, nullable — Contact person's title. Accepts custom values. e.g. Mr, Mrs, Miss, Honourable, Judge.
    - `firstName` string, nullable — Contact person's first name.
    - `middleName` string, nullable — Contact person's middle name (if applicable).
    - `lastName` string, nullable — Contact person's last name.
    - `nameSuffix` string, nullable — Contact person's name suffix (if applicable).
    - `customName` string, nullable — Contact person's custom name to be used in letters (if applicable).
    - `otherNames` string, nullable — Contact person's other names (if applicable). Only supported in the US.
    - `residentialAddress` AddressDto
      - `careOf` string, nullable — Care of the addressee (if applicable).
      - `buildingLevel` string, nullable — Building level in address (if applicable).
      - `unitNumber` string, nullable — Unit number in address (if applicable).
      - `unitType` string, nullable — Unit type in address (if applicable). Accepts custom values. e.g. Apartment, Unit, Flat, Villa, Suite.
      - `streetNumber` string, nullable — Street number in address.
      - `streetName` string, nullable — Street name in address.
      - `streetType` string, nullable — Street type. Accepts custom values. e.g. Street, Road, Avenue, Lane.
      - `addressLine1` string, nullable — First line of address. Only supported in the US.
      - `addressLine2` string, nullable — Second line of address (if applicable). Only supported in the US.
      - `city` string, nullable — City, district, suburb, town, or village.
      - `state` string, nullable — State, province, or region.
      - `zipCode` string, nullable — Zip or post code.
      - `locality` string, nullable — Locality. Only supported in the UK.
      - `county` string, nullable — County. Only supported in the US and UK.
      - `country` string, nullable — Country.
      - `poBox` PoBoxAddressDto — PO Box address.
        - `careOf` string, nullable — Care of the addressee (if applicable).
        - `poBoxType` string, nullable — PO Box type. Accepts custom values. e.g. Care PO, PO Box, Locked Bag, RMS.
        - `poBoxNumber` string, nullable — PO Box number.
        - `city` string, nullable — City, district, suburb, town, or village.
        - `state` string, nullable — State, province, or region.
        - `zipCode` string, nullable — Zip or post code.
    - `mailingAddress` AddressDto
      - `careOf` string, nullable — Care of the addressee (if applicable).
      - `buildingLevel` string, nullable — Building level in address (if applicable).
      - `unitNumber` string, nullable — Unit number in address (if applicable).
      - `unitType` string, nullable — Unit type in address (if applicable). Accepts custom values. e.g. Apartment, Unit, Flat, Villa, Suite.
      - `streetNumber` string, nullable — Street number in address.
      - `streetName` string, nullable — Street name in address.
      - `streetType` string, nullable — Street type. Accepts custom values. e.g. Street, Road, Avenue, Lane.
      - `addressLine1` string, nullable — First line of address. Only supported in the US.
      - `addressLine2` string, nullable — Second line of address (if applicable). Only supported in the US.
      - `city` string, nullable — City, district, suburb, town, or village.
      - `state` string, nullable — State, province, or region.
      - `zipCode` string, nullable — Zip or post code.
      - `locality` string, nullable — Locality. Only supported in the UK.
      - `county` string, nullable — County. Only supported in the US and UK.
      - `country` string, nullable — Country.
      - `poBox` PoBoxAddressDto — PO Box address.
        - `careOf` string, nullable — Care of the addressee (if applicable).
        - `poBoxType` string, nullable — PO Box type. Accepts custom values. e.g. Care PO, PO Box, Locked Bag, RMS.
        - `poBoxNumber` string, nullable — PO Box number.
        - `city` string, nullable — City, district, suburb, town, or village.
        - `state` string, nullable — State, province, or region.
        - `zipCode` string, nullable — Zip or post code.
    - `phone` PhoneNumberDto
      - `areaCode` string, nullable — Phone area code.
      - `number` string, nullable — Phone number (excluding area code).
    - `phone2` PhoneNumberWithExtensionDto
      - `areaCode` string, nullable — Phone area code. Only supported in the US.
      - `number` string, nullable — Phone number (excluding area code).
      - `extension` string, nullable — Phone number extension. Accepts numeric characters only.
    - `fax` PhoneNumberDto
      - `areaCode` string, nullable — Phone area code.
      - `number` string, nullable — Phone number (excluding area code).
    - `cell` PhoneNumberDto
      - `areaCode` string, nullable — Phone area code.
      - `number` string, nullable — Phone number (excluding area code).
    - `email` string, nullable — Contact person's email address.
    - `notes` string, nullable — Additional notes about contact (if applicable).
    - `occupation` string, nullable — Contact person's occupation.
    - `birthDate` string, date-time, nullable — Contact person's date of birth.
    - `birthPlace` string, nullable — Contact person's place of birth.
    - `birthState` string, nullable — Contact person's birth state.
    - `birthCountry` string, nullable — Contact person's birth country.
    - `identificationNumberType` string, nullable — Contact person's type of identification. e.g. SSN, ITIN Only supported in the US.
    - `identificationNumber` string, nullable — Contact person's identification number. Only supported in the US.
    - `passportDetails` PassportDetailsDto
      - `passportNumber` string, nullable — Contact person's passport number.
      - `passportIssueDate` string, date-time, nullable — Contact person's passport issue date.
      - `passportExpireDate` string, date-time, nullable — Contact person's passport expiry date.
      - `passportIssueCountry` string, nullable — Contact person's passport country of issue.
      - `passportIssueAuthority` string, nullable — Contact person's passport issuing authority. Only supported in the UK.
    - `deathDetails` DeathDetailsDto
      - `deathDate` string, date-time, nullable — Contact person's date of death.
      - `isDeathDateUnknown` boolean — Whether the person's exact date of death is known.
      - `deathDateFrom` string, date-time, nullable — Starting range for person's possible date of death.
      - `deathDateTo` string, date-time, nullable — Ending range for person's possible date of death.
      - `deathPlace` string, nullable — Contact person's place of death.
      - `deathState` string, nullable — Contact person's death state. Only supported in AU and US.
      - `deathCountry` string, nullable — Contact person's death country.
      - `deathCounty` string, nullable — Contact person's death county. Only supported in US.
    - `gender` string, nullable — Contact person's gender. Accepted values - Male, Female, Other as well as any free text.
    - `maritalStatus` string, nullable — Contact person's marital status. Accepts custom values. e.g. Single, Married, Separated, Divorced, Widowed, De facto.
    - `specialNeeds` string, nullable — Brief description of an special needs (if applicable).
    - `birthFirstName` string, nullable — Contact person's first name at birth.
    - `birthMiddleName` string, nullable — Contact person's middle name at birth.
    - `birthLastName` string, nullable — Contact person's last name at birth.
    - `previousNames` string, nullable — Contact person's previous names.
    - `correctionsReferenceNumber` string, nullable — Contact person's corrections reference number. Only supported in Australia.
    - `centrelinkReferenceNumber` string, nullable — Contact person's centrelink reference number. Only supported in Australia.
    - `identificationDetails` IdentificationDetailsDto
      - `alienNumber` string, nullable — Alien number Only supported in the US.
      - `registrationAuthority` string, nullable — Registration authority Only supported in the US.
      - `registrationNumber` string, nullable — Registration number Only supported in the US.
      - `driversLicenseNumber` string, nullable — Driver's license number
      - `driversLicenseState` string, nullable — Driver's licence state <example>IL</example><example>NSW</example>
      - `medicareNumber` string, nullable — Medicare number
    - `citizenshipDetails` CitizenshipDetailsDto
      - `countryOfCitizenship` string, nullable — Country of citizenship
      - `nationality` string, nullable — Nationality
      - `languageOfInterpreter` string, nullable — Language of interpreter
    - `utbmsDetails` UtbmsDetailsDto — Utbms Details
      - `ledesClientId` string, nullable — LEDES client Id
    - `executionOptions` PersonExecutionOptionsDto — Execution options for individual persons (Power of Attorney) Only supported in AU.
      - `poaType` string, nullable — Power of Attorney type. Possible values: 'None', 'General', 'Enduring', 'Medical', 'Financial', 'Other', 'Unset'
      - `poaDate` string, date-time, nullable — Date the Power of Attorney was executed
      - `attorneyName` string, nullable — Name of the attorney
      - `address` AddressDto
        - `careOf` string, nullable — Care of the addressee (if applicable).
        - `buildingLevel` string, nullable — Building level in address (if applicable).
        - `unitNumber` string, nullable — Unit number in address (if applicable).
        - `unitType` string, nullable — Unit type in address (if applicable). Accepts custom values. e.g. Apartment, Unit, Flat, Villa, Suite.
        - `streetNumber` string, nullable — Street number in address.
        - `streetName` string, nullable — Street name in address.
        - `streetType` string, nullable — Street type. Accepts custom values. e.g. Street, Road, Avenue, Lane.
        - `addressLine1` string, nullable — First line of address. Only supported in the US.
        - `addressLine2` string, nullable — Second line of address (if applicable). Only supported in the US.
        - `city` string, nullable — City, district, suburb, town, or village.
        - `state` string, nullable — State, province, or region.
        - `zipCode` string, nullable — Zip or post code.
        - `locality` string, nullable — Locality. Only supported in the UK.
        - `county` string, nullable — County. Only supported in the US and UK.
        - `country` string, nullable — Country.
        - `poBox` PoBoxAddressDto — PO Box address.
          - `careOf` string, nullable — Care of the addressee (if applicable).
          - `poBoxType` string, nullable — PO Box type. Accepts custom values. e.g. Care PO, PO Box, Locked Bag, RMS.
          - `poBoxNumber` string, nullable — PO Box number.
          - `city` string, nullable — City, district, suburb, town, or village.
          - `state` string, nullable — State, province, or region.
          - `zipCode` string, nullable — Zip or post code.
      - `poaRegisteredBook` string, nullable — Power of Attorney registration book reference
      - `poaRegisteredNumber` string, nullable — Power of Attorney registration number
      - `executionType` string, nullable — Person execution type. Possible values: 'Individual', 'PowerOfAttorney', 'Other', 'Unset', 'None'
  - `company` CompanyDto
    - `name` string, nullable — Company's name.
    - `type` string, nullable — Company's type. Possible values for US: 'Corporation', 'Government Agency', 'Limited Liability Company', 'Sole Proprietor', 'Partnership', 'Not-for-Profit' Possible values for AU: 'Company', 'Sole Proprietor', 'Partnership', 'Government Department' Possible values for UK: 'Company', 'Sole Trader', 'Partnership', 'Limited Liability Partnership', 'Government Department'
    - `phone` PhoneNumberDto
      - `areaCode` string, nullable — Phone area code.
      - `number` string, nullable — Phone number (excluding area code).
    - `fax` PhoneNumberDto
      - `areaCode` string, nullable — Phone area code.
      - `number` string, nullable — Phone number (excluding area code).
    - `email` string, nullable — Company's email address.
    - `website` string, nullable — Company's website URL.
    - `notes` string, nullable — Additional notes for company (if applicable).
    - `businessAddress` AddressWithDxAddressDto
      - `careOf` string, nullable — Care of the addressee (if applicable).
      - `buildingLevel` string, nullable — Building level in address (if applicable).
      - `unitNumber` string, nullable — Unit number in address (if applicable).
      - `unitType` string, nullable — Unit type in address (if applicable). Accepts custom values. e.g. Apartment, Unit, Flat, Villa, Suite.
      - `streetNumber` string, nullable — Street number in address.
      - `streetName` string, nullable — Street name in address.
      - `streetType` string, nullable — Street type. Accepts custom values. e.g. Street, Road, Avenue, Lane.
      - `addressLine1` string, nullable — First line of address. Only supported in the US.
      - `addressLine2` string, nullable — Second line of address (if applicable). Only supported in the US.
      - `city` string, nullable — City, district, suburb, town, or village.
      - `state` string, nullable — State, province, or region.
      - `zipCode` string, nullable — Zip or post code.
      - `locality` string, nullable — Locality. Only supported in the UK.
      - `county` string, nullable — County. Only supported in the US and UK.
      - `country` string, nullable — Country.
      - `poBox` PoBoxAddressDto — PO Box address.
        - `careOf` string, nullable — Care of the addressee (if applicable).
        - `poBoxType` string, nullable — PO Box type. Accepts custom values. e.g. Care PO, PO Box, Locked Bag, RMS.
        - `poBoxNumber` string, nullable — PO Box number.
        - `city` string, nullable — City, district, suburb, town, or village.
        - `state` string, nullable — State, province, or region.
        - `zipCode` string, nullable — Zip or post code.
      - `dxAddress` DxAddressDto
        - `number` string, nullable
        - `exchange` string, nullable
        - `state` string, nullable
    - `mailingAddress` AddressDto
      - `careOf` string, nullable — Care of the addressee (if applicable).
      - `buildingLevel` string, nullable — Building level in address (if applicable).
      - `unitNumber` string, nullable — Unit number in address (if applicable).
      - `unitType` string, nullable — Unit type in address (if applicable). Accepts custom values. e.g. Apartment, Unit, Flat, Villa, Suite.
      - `streetNumber` string, nullable — Street number in address.
      - `streetName` string, nullable — Street name in address.
      - `streetType` string, nullable — Street type. Accepts custom values. e.g. Street, Road, Avenue, Lane.
      - `addressLine1` string, nullable — First line of address. Only supported in the US.
      - `addressLine2` string, nullable — Second line of address (if applicable). Only supported in the US.
      - `city` string, nullable — City, district, suburb, town, or village.
      - `state` string, nullable — State, province, or region.
      - `zipCode` string, nullable — Zip or post code.
      - `locality` string, nullable — Locality. Only supported in the UK.
      - `county` string, nullable — County. Only supported in the US and UK.
      - `country` string, nullable — Country.
      - `poBox` PoBoxAddressDto — PO Box address.
        - `careOf` string, nullable — Care of the addressee (if applicable).
        - `poBoxType` string, nullable — PO Box type. Accepts custom values. e.g. Care PO, PO Box, Locked Bag, RMS.
        - `poBoxNumber` string, nullable — PO Box number.
        - `city` string, nullable — City, district, suburb, town, or village.
        - `state` string, nullable — State, province, or region.
        - `zipCode` string, nullable — Zip or post code.
    - `abn` string, nullable — For AU: Australian Company Number (ABN) of the company. For UK: Company Registration Number (CRN) of the company. Only supported in AU and UK.
    - `ein` string, nullable — Employer Identification Number (EIN) of the company. Only supported in US.
    - `registeredDate` string, date-time, nullable — Date the company was registered. Only supported in US.
    - `stateId` string, nullable — State ID of the company. Only supported in US.
    - `stateRegisteredIn` string, nullable — state in which the company is registered. Only supported in US.
    - `countryRegisteredIn` string, nullable — Country in which the company is registered. Only supported in US.
    - `branch` string, nullable — Branch of the company. Only supported in US.
    - `registeredAddress` AddressDto
      - `careOf` string, nullable — Care of the addressee (if applicable).
      - `buildingLevel` string, nullable — Building level in address (if applicable).
      - `unitNumber` string, nullable — Unit number in address (if applicable).
      - `unitType` string, nullable — Unit type in address (if applicable). Accepts custom values. e.g. Apartment, Unit, Flat, Villa, Suite.
      - `streetNumber` string, nullable — Street number in address.
      - `streetName` string, nullable — Street name in address.
      - `streetType` string, nullable — Street type. Accepts custom values. e.g. Street, Road, Avenue, Lane.
      - `addressLine1` string, nullable — First line of address. Only supported in the US.
      - `addressLine2` string, nullable — Second line of address (if applicable). Only supported in the US.
      - `city` string, nullable — City, district, suburb, town, or village.
      - `state` string, nullable — State, province, or region.
      - `zipCode` string, nullable — Zip or post code.
      - `locality` string, nullable — Locality. Only supported in the UK.
      - `county` string, nullable — County. Only supported in the US and UK.
      - `country` string, nullable — Country.
      - `poBox` PoBoxAddressDto — PO Box address.
        - `careOf` string, nullable — Care of the addressee (if applicable).
        - `poBoxType` string, nullable — PO Box type. Accepts custom values. e.g. Care PO, PO Box, Locked Bag, RMS.
        - `poBoxNumber` string, nullable — PO Box number.
        - `city` string, nullable — City, district, suburb, town, or village.
        - `state` string, nullable — State, province, or region.
        - `zipCode` string, nullable — Zip or post code.
    - `firmIsRegisteredAgent` boolean, nullable — Whether the firm is a registered agent. Only supported in US.
    - `companyManagedBy` 0 | 1
    - `companyNumberType` string, nullable — Company's Australian company number type. Possible values: 'ACN', 'ARBN' Only supported in AU.
    - `companyNumber` string, nullable — Company's Australian Company Number. Only supported in AU.
    - `doingBusinessAsName` string, nullable — Doing Business As (DBA) name. Only supported in US.
    - `tradingAs` string, nullable — Trading As type (e.g. 'Trading As', 'Doing Business As'). Only supported in AU.
    - `tradingName` string, nullable — Trading name of the organisation. Only supported in AU and UK.
    - `staffIds` string[], nullable — List of Staff IDs for this company.
    - `directorIds` string[], nullable — List of Director IDs for this company.
    - `executionOptions` ExecutionOptionsDto — Execution options for organizations (Company, Partnership, Sole Proprietor) Only supported in AU.
      - `person1` ExecutionPersonDto — Represents an authorized person for organization execution Only supported in AU.
        - `name` string, nullable — Person's full name
        - `address` AddressDto
          - `careOf` string, nullable — Care of the addressee (if applicable).
          - `buildingLevel` string, nullable — Building level in address (if applicable).
          - `unitNumber` string, nullable — Unit number in address (if applicable).
          - `unitType` string, nullable — Unit type in address (if applicable). Accepts custom values. e.g. Apartment, Unit, Flat, Villa, Suite.
          - `streetNumber` string, nullable — Street number in address.
          - `streetName` string, nullable — Street name in address.
          - `streetType` string, nullable — Street type. Accepts custom values. e.g. Street, Road, Avenue, Lane.
          - `addressLine1` string, nullable — First line of address. Only supported in the US.
          - `addressLine2` string, nullable — Second line of address (if applicable). Only supported in the US.
          - `city` string, nullable — City, district, suburb, town, or village.
          - `state` string, nullable — State, province, or region.
          - `zipCode` string, nullable — Zip or post code.
          - `locality` string, nullable — Locality. Only supported in the UK.
          - `county` string, nullable — County. Only supported in the US and UK.
          - `country` string, nullable — Country.
          - `poBox` PoBoxAddressDto — PO Box address.
            - `careOf` string, nullable — Care of the addressee (if applicable).
            - `poBoxType` string, nullable — PO Box type. Accepts custom values. e.g. Care PO, PO Box, Locked Bag, RMS.
            - `poBoxNumber` string, nullable — PO Box number.
            - `city` string, nullable — City, district, suburb, town, or village.
            - `state` string, nullable — State, province, or region.
            - `zipCode` string, nullable — Zip or post code.
        - `personType` string, nullable — Person type for execution. Possible values: 'Director', 'Secretary', 'SoleDirectorAndSecretary', 'AuthorisedSignatory', 'Other', 'Unset'
        - `selectedOfficeHeld` string, nullable — Office held by the person. Possible values: 'Director', 'Secretary', 'SoleDirectorAndSecretary', 'Partner', 'AuthorisedRepresentative', 'Other', 'Unset'
      - `person2` ExecutionPersonDto — Represents an authorized person for organization execution Only supported in AU.
        - `name` string, nullable — Person's full name
        - `address` AddressDto
          - `careOf` string, nullable — Care of the addressee (if applicable).
          - `buildingLevel` string, nullable — Building level in address (if applicable).
          - `unitNumber` string, nullable — Unit number in address (if applicable).
          - `unitType` string, nullable — Unit type in address (if applicable). Accepts custom values. e.g. Apartment, Unit, Flat, Villa, Suite.
          - `streetNumber` string, nullable — Street number in address.
          - `streetName` string, nullable — Street name in address.
          - `streetType` string, nullable — Street type. Accepts custom values. e.g. Street, Road, Avenue, Lane.
          - `addressLine1` string, nullable — First line of address. Only supported in the US.
          - `addressLine2` string, nullable — Second line of address (if applicable). Only supported in the US.
          - `city` string, nullable — City, district, suburb, town, or village.
          - `state` string, nullable — State, province, or region.
          - `zipCode` string, nullable — Zip or post code.
          - `locality` string, nullable — Locality. Only supported in the UK.
          - `county` string, nullable — County. Only supported in the US and UK.
          - `country` string, nullable — Country.
          - `poBox` PoBoxAddressDto — PO Box address.
            - `careOf` string, nullable — Care of the addressee (if applicable).
            - `poBoxType` string, nullable — PO Box type. Accepts custom values. e.g. Care PO, PO Box, Locked Bag, RMS.
            - `poBoxNumber` string, nullable — PO Box number.
            - `city` string, nullable — City, district, suburb, town, or village.
            - `state` string, nullable — State, province, or region.
            - `zipCode` string, nullable — Zip or post code.
        - `personType` string, nullable — Person type for execution. Possible values: 'Director', 'Secretary', 'SoleDirectorAndSecretary', 'AuthorisedSignatory', 'Other', 'Unset'
        - `selectedOfficeHeld` string, nullable — Office held by the person. Possible values: 'Director', 'Secretary', 'SoleDirectorAndSecretary', 'Partner', 'AuthorisedRepresentative', 'Other', 'Unset'
      - `executingUnder127` boolean, nullable — Indicates if executing under section 127
      - `executingAuthority` string, nullable — Executing authority details
      - `sealType` string, nullable — Seal type for execution. Possible values: 'WithSeal', 'WithoutSeal', 'Unset'
      - `authorisedDepositTakingInstitution` boolean, nullable — Indicates if organization is an Authorised Deposit Taking Institution
      - `poaRegistrationNumber` string, nullable — Power of Attorney registration number
      - `attorneyNames` string[], nullable — List of attorney names
      - `executionType` string, nullable — Execution type. Possible values: 'Individual', 'SoleDirector', 'JointDirectors', 'Director', 'Secretary', 'Authorised', 'Other', 'Unset', 'None'
  - `trust` TrustDto
    - `name` string, nullable — Trust's name.
    - `status` string, nullable — Trust's status. Standard values are: as Trustee of, as Trustees of, as Co-Trustees of, as an Individual and as Trustee of, as Successor Trustee of. A custom value can be supplied instead.
    - `trustNumber` string, nullable — Trust's number.
    - `executedDate` string, date-time, nullable — Date trust was executed.
    - `phone` PhoneNumberDto
      - `areaCode` string, nullable — Phone area code.
      - `number` string, nullable — Phone number (excluding area code).
    - `fax` PhoneNumberDto
      - `areaCode` string, nullable — Phone area code.
      - `number` string, nullable — Phone number (excluding area code).
    - `address` AddressDto
      - `careOf` string, nullable — Care of the addressee (if applicable).
      - `buildingLevel` string, nullable — Building level in address (if applicable).
      - `unitNumber` string, nullable — Unit number in address (if applicable).
      - `unitType` string, nullable — Unit type in address (if applicable). Accepts custom values. e.g. Apartment, Unit, Flat, Villa, Suite.
      - `streetNumber` string, nullable — Street number in address.
      - `streetName` string, nullable — Street name in address.
      - `streetType` string, nullable — Street type. Accepts custom values. e.g. Street, Road, Avenue, Lane.
      - `addressLine1` string, nullable — First line of address. Only supported in the US.
      - `addressLine2` string, nullable — Second line of address (if applicable). Only supported in the US.
      - `city` string, nullable — City, district, suburb, town, or village.
      - `state` string, nullable — State, province, or region.
      - `zipCode` string, nullable — Zip or post code.
      - `locality` string, nullable — Locality. Only supported in the UK.
      - `county` string, nullable — County. Only supported in the US and UK.
      - `country` string, nullable — Country.
      - `poBox` PoBoxAddressDto — PO Box address.
        - `careOf` string, nullable — Care of the addressee (if applicable).
        - `poBoxType` string, nullable — PO Box type. Accepts custom values. e.g. Care PO, PO Box, Locked Bag, RMS.
        - `poBoxNumber` string, nullable — PO Box number.
        - `city` string, nullable — City, district, suburb, town, or village.
        - `state` string, nullable — State, province, or region.
        - `zipCode` string, nullable — Zip or post code.
    - `trustees` TrusteeDto[], nullable — List of trustees.
      - `name` string, nullable — Trustee's name.
      - `type` string, nullable — Type of trustee. Standard values are: Company, Individual. A custom value can be supplied instead.
  - `groupOfPeople` GroupOfPeopleDto
    - `peopleIds` string[], nullable — List of contact person Ids.
    - `residentialAddress` AddressDto
      - `careOf` string, nullable — Care of the addressee (if applicable).
      - `buildingLevel` string, nullable — Building level in address (if applicable).
      - `unitNumber` string, nullable — Unit number in address (if applicable).
      - `unitType` string, nullable — Unit type in address (if applicable). Accepts custom values. e.g. Apartment, Unit, Flat, Villa, Suite.
      - `streetNumber` string, nullable — Street number in address.
      - `streetName` string, nullable — Street name in address.
      - `streetType` string, nullable — Street type. Accepts custom values. e.g. Street, Road, Avenue, Lane.
      - `addressLine1` string, nullable — First line of address. Only supported in the US.
      - `addressLine2` string, nullable — Second line of address (if applicable). Only supported in the US.
      - `city` string, nullable — City, district, suburb, town, or village.
      - `state` string, nullable — State, province, or region.
      - `zipCode` string, nullable — Zip or post code.
      - `locality` string, nullable — Locality. Only supported in the UK.
      - `county` string, nullable — County. Only supported in the US and UK.
      - `country` string, nullable — Country.
      - `poBox` PoBoxAddressDto — PO Box address.
        - `careOf` string, nullable — Care of the addressee (if applicable).
        - `poBoxType` string, nullable — PO Box type. Accepts custom values. e.g. Care PO, PO Box, Locked Bag, RMS.
        - `poBoxNumber` string, nullable — PO Box number.
        - `city` string, nullable — City, district, suburb, town, or village.
        - `state` string, nullable — State, province, or region.
        - `zipCode` string, nullable — Zip or post code.
    - `mailingAddress` AddressDto
      - `careOf` string, nullable — Care of the addressee (if applicable).
      - `buildingLevel` string, nullable — Building level in address (if applicable).
      - `unitNumber` string, nullable — Unit number in address (if applicable).
      - `unitType` string, nullable — Unit type in address (if applicable). Accepts custom values. e.g. Apartment, Unit, Flat, Villa, Suite.
      - `streetNumber` string, nullable — Street number in address.
      - `streetName` string, nullable — Street name in address.
      - `streetType` string, nullable — Street type. Accepts custom values. e.g. Street, Road, Avenue, Lane.
      - `addressLine1` string, nullable — First line of address. Only supported in the US.
      - `addressLine2` string, nullable — Second line of address (if applicable). Only supported in the US.
      - `city` string, nullable — City, district, suburb, town, or village.
      - `state` string, nullable — State, province, or region.
      - `zipCode` string, nullable — Zip or post code.
      - `locality` string, nullable — Locality. Only supported in the UK.
      - `county` string, nullable — County. Only supported in the US and UK.
      - `country` string, nullable — Country.
      - `poBox` PoBoxAddressDto — PO Box address.
        - `careOf` string, nullable — Care of the addressee (if applicable).
        - `poBoxType` string, nullable — PO Box type. Accepts custom values. e.g. Care PO, PO Box, Locked Bag, RMS.
        - `poBoxNumber` string, nullable — PO Box number.
        - `city` string, nullable — City, district, suburb, town, or village.
        - `state` string, nullable — State, province, or region.
        - `zipCode` string, nullable — Zip or post code.
  - `isDeleted` boolean — Contact can be restored by setting this to false.

## Response `202`

When request is accepted. Returns a 'Link' object.

- Link
  - `id` string, nullable
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable

## Other responses

- `400` — When an unsupported request is made.
- `403` — When contact with specified id is not associated with authenticated client.
- `404` — When contact with specified id does not exist.

---

[API](https://skmtc.net/smokeball/apis/api.md) · [All operations](https://skmtc.net/smokeball/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smokeball/api/revisions/197984da9b42/schema)