Update a contact - Aptly API

curl --request POST \ --url https://core-api.getaptly.com/api/contacts/{contactId} \ --header 'Content-Type: application/json' \ --header 'x-token: <api-key>' \ --data ' { "firstname": "Jane", "lastname": "Smith", "email": "[email protected]" } '

{ "_id": "<string>", "uuid": "<string>", "firstname": "<string>", "lastname": "<string>", "fullName": "<string>", "duogram": "<string>", "photoId": "<string>", "imageUrl": "<string>", "email": "<string>", "phone": "<string>", "typeId": "<string>", "companyId": "<string>", "address": {}, "title": "<string>", "alerts": [ {} ], "company": "<string>", "isCompany": true }

Authorizations

x-token

string

header

required

Path Parameters

contactId

string

required

The contact's _id.

Body

application/json

firstname

string

lastname

string

One or more email addresses.

phone

object[]

Show child attributes

typeId

string

Contact type ID.

contactType

string

Contact type name (alternative to typeId).

isCompany

boolean

title

string

company

string

imageUrl

string

Absolute URL to a JPG or PNG photo.

customFields

object

Map of custom field ID to value.

Response

Updated contact.

_id

string

MongoDB ObjectId of the contact.

uuid

string

firstname

string

lastname

string

fullName

string

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

duogram

string

Two-letter initials derived from first and last name.

photoId

string | null

imageUrl

string | null

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

string

phone

string

typeId

string

companyId

string

address

object

title

string

alerts

object[]

company

string

Company name — populated when isCompany is true.

isCompany

boolean