v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Phone Book Entries

Update a contact

Updates an existing contact with the provided information.

put/contacts/{contactId}

Path parameters

contactIdstring required

The ID of the contact to update.

Request body

firstNamestring

First name of the contact

lastNamestring

Last name of the contact

nicknamestring

Nickname of the contact

titlestring

Title of the contact (e.g. Dr., Mr., Mrs.)

companystring

Company name

emailsstring[]

List of email addresses

phonesstring[]

List of phone numbers

preferredContactMethodstring

Preferred contact method

emailstring

Primary email address

phonestring

Primary phone number

notesstring

Additional notes about the contact

Response

Contact updated successfully.

_idstring required

Contact ID

accountIdstring required

Account ID

fullNamestring required

Full name of the contact

firstNamestring

First name of the contact

lastNamestring

Last name of the contact

nicknamestring

Nickname of the contact

titlestring

Title of the contact (e.g. Dr., Mr., Mrs.)

companystring

Company name

emailsstring[]

List of email addresses

phonesstring[]

List of phone numbers

preferredContactMethodstring

Preferred contact method

emailstring

Primary email address

phonestring

Primary phone number

notesstring

Additional notes about the contact

Example response

{
  "_id": "60d21b4667d0d8992e610c85",
  "accountId": "5a5786a0c526211500d261d9",
  "fullName": "John Doe",
  "firstName": "John",
  "lastName": "Doe",
  "nickname": "Johnny",
  "title": "Mr.",
  "company": "Acme Inc.",
  "picture": {
    "thumbnail": "https://example.com/thumbnail.jpg",
    "regular": "https://example.com/regular.jpg",
    "large": "https://example.com/large.jpg"
  },
  "emails": [
    "john.doe@example.com",
    "johndoe@company.com"
  ],
  "phones": [
    "+1234567890",
    "+9876543210"
  ],
  "preferredContactMethod": "email",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "notes": "Test contact note"
}