Skip to main content
POST
/
api
/
contacts
/
{contactId}
Update a contact
curl --request POST \
  --url https://core-api.getaptly.com/api/contacts/{contactId} \
  --header 'Content-Type: application/json' \
  --header 'x-token: <api-key>' \
  --data '
{
  "First Name": "Jane",
  "Last Name": "Smith-Jones",
  "Email": "janesmith@newdomain.com",
  "Title": "Property Manager",
  "imageUrl": "https://cdn.getaptly.com/photos/abc123.jpg",
  "customFields": {
    "DbJT6rMdnuds7vSbP": true,
    "5D8LYiyMt54aKD7x9": "Primary Tenant"
  }
}
'
{}

Authorizations

​
x-token
string
header
required

Path Parameters

​
contactId
string
required

The contact's _id.

Body

application/json
​
_id
string

Provide to update an existing contact by ID.

​
First Name
string
​
Last Name
string
​
Contact Type
string

Contact type name (e.g. Tenant). Must match an existing type in the company.

​
Title
string

Job title.

​
Company
string
​
Email
string<email>
​
Home Phone
string
​
Mobile Phone
string
​
Work Phone
string
​
imageUrl
string

URL of the contact's photo. Must end in .jpg, .jpeg, or .png. Stored and returned in subsequent reads.

​
customFields
object

Custom fields for the contact, keyed by field ID. The valid field IDs depend on the contact's type. Pass { "<fieldId>": value } — the field definition is looked up automatically. On read, each entry is enriched to { name, dataType, optional, value }.

Response

Contact updated.

The response is of type object.