PATCH
/
public
/
v1
/
contact
/
{contactId}
curl --request PATCH \
  --url https://api.hifello.com/public/v1/contact/{contactId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "John Doe",
  "phone": "1234567890",
  "email": "john@example.com",
  "crmFields": {
    "name": "ExampleCRM",
    "url": "https://example.com/crm/1234567890",
    "source": "API",
    "stage": "Lead",
    "createdDate": "2025-01-01T00:00:00.000Z"
  },
  "assignedUserEmailId": "<string>",
  "recordStatus": "Marketing"
}'
{
  "contactId": "Fello's unique identifier for a contact.",
  "name": "Miller Davis",
  "phone": "1234567890",
  "email": "miller@example.com",
  "emailStatus": "Valid",
  "recordStatus": "Marketing",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "tags": [
    "HOT LEAD"
  ],
  "engagement": {
    "numOfFormSubmissions": 123,
    "lastFormSubmissionDate": "2025-01-01T00:00:00.000Z",
    "numOfEmailSends": 123,
    "lastEmailSentDate": "2025-01-01T00:00:00.000Z",
    "numOfEmailOpens": 123,
    "lastEmailOpenDate": "2025-01-01T00:00:00.000Z",
    "numOfEmailClicks": 123,
    "lastEmailClickDate": "2025-01-01T00:00:00.000Z",
    "numOfDashboardViews": 123,
    "lastDashboardViewedDate": "2025-01-01T00:00:00.000Z",
    "numOfDashboardClicks": 123,
    "lastDashboardClickedDate": "2025-01-01T00:00:00.000Z"
  },
  "properties": [
    {
      "propertyId": "<string>",
      "address": {
        "aptOrUnitNumber": "6",
        "streetAddress": "Main St",
        "city": "Anytown",
        "county": "Cuyahoga",
        "state": "OH",
        "zip": "44022"
      }
    }
  ],
  "crmFields": {
    "name": "ExampleCRM",
    "url": "https://example.com/crm/1234567890",
    "source": "API",
    "stage": "Lead",
    "createdDate": "2025-01-01T00:00:00.000Z"
  },
  "assignedUserEmailId": "<string>",
  "proofOfConsentUrl": "<string>"
}

This API accepts an optional set of fields, and only those explicitly provided will be updated.

Authorizations

​
x-api-key
string
header
required

The API Key generated from your Fello account.

Path Parameters

​
contactId
string
required

Fello's unique identifier for a contact.

Body

application/json

Response

200
application/json
Success

The response is of type object.