Contacts

Update a contact

Updates an existing contact by ID using the same upsert logic as POST /api/contacts. The _id is taken from the URL — any _id in the body is ignored.

Accepts the same native or legacy body formats as POST /api/contacts. Returns the updated, enriched contact.

post/api/contacts/{contactId}

Request

Base URL
https://core-api.getaptly.com
Auth
- API key in header x-token
- or API key in header Authorization
TypeScript
https://skmtc.dev/getaptly/apis/aptly-api/docs/api/contacts/:contactId/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

contactIdstring required

The contact's _id.

Request body

firstnamestring

lastnamestring

typeIdstring

Contact type ID.

contactTypestring

Contact type name (alternative to typeId).

isCompanyboolean

titlestring

companystring

imageUrlstring

Absolute URL to a JPG or PNG photo.

customFieldsobject

Map of custom field ID to value.

Response

Updated contact.

_idstring

MongoDB ObjectId of the contact.

uuidstring

firstnamestring

lastnamestring

fullNamestring

Computed display name (first + last, or company name for org records).

duogramstring

Two-letter initials derived from first and last name.

photoIdstring nullable

imageUrlstring nullable

CDN thumbnail URL for the contact's photo, or null if none.

emailstring

phonestring

typeIdstring

companyIdstring

addressobject

titlestring

alertsobject[]

companystring

Company name — populated when isCompany is true.