Skip to main content
PATCH
/
public
/
v1
/
contact
/
{contactId}
Update Contact Basic Details
curl --request PATCH \
  --url https://api.fello.ai/public/v1/contact/{contactId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "John Doe",
  "phone": "1234567890",
  "email": "[email protected]",
  "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": "[email protected]",
  "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"
  },
  "leadScore": 90,
  "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.

Minimum string length: 1

Body

application/json
​
name
string

Full name of the contact.

Maximum string length: 64
Example:

"John Doe"

​
phone
string

Phone number of the contact

Maximum string length: 32
Example:

"1234567890"

​
email
string

The contact's primary email address.

Example:

"[email protected]"

​
crmFields
object
​
assignedUserEmailId
string

Email address of the assigned user with the contact.

​
recordStatus
enum<string>

The record status (Marketing/Non-Marketing) of a contact in Fello.

Available options:
Marketing,
NonMarketing

Response

Success

​
contactId
string
Example:

"Fello's unique identifier for a contact."

​
name
string

Full Name of the contact

Example:

"Miller Davis"

​
phone
string

Phone number of the contact

Example:

"1234567890"

​
email
string

Primary Email of the contact

Example:

"[email protected]"

​
emailStatus
enum<string>
Available options:
Invalid,
Valid,
Pending
Example:

"Valid"

​
recordStatus
enum<string>
Available options:
Marketing,
NonMarketing
Example:

"Marketing"

​
createdAt
string

Contact Created Date

Example:

"2025-01-01T00:00:00.000Z"

​
tags
string[]

Tags associated with the contact

Example:
["HOT LEAD"]
​
engagement
object
​
properties
object[]
​
crmFields
object
​
leadScore
number

Lead Score for this contact

Example:

90

​
assignedUserEmailId
string
​
proofOfConsentUrl
string