Skip to main content
POST
/
public
/
v1
/
contact
Add Contact with relevant data
curl --request POST \
  --url https://api.fello.ai/public/v1/contact \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "miller@example.com",
  "name": "Miller Davis",
  "phone": "1234567890",
  "tags": [
    "HOT LEAD"
  ],
  "address": "<string>",
  "crmFields": {
    "name": "ExampleCRM",
    "url": "https://example.com/crm/1234567890",
    "source": "API",
    "stage": "Lead",
    "createdDate": "2025-01-01T00:00:00.000Z"
  },
  "assignedUserEmailId": "tim@example.com"
}
'
{
  "contact": {
    "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"
    },
    "leadScore": 90,
    "assignedUserEmailId": "<string>",
    "proofOfConsentUrl": "<string>"
  },
  "warnings": [
    "InvalidInputAddress"
  ]
}

Authorizations

​
x-api-key
string
header
required

The API Key generated from your Fello account.

Body

application/json
​
email
string
required

Primary email of the contact.

Minimum string length: 1
Pattern: ^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
Example:

"miller@example.com"

​
name
string

Full Name of the contact.

Maximum string length: 64
Example:

"Miller Davis"

​
phone
string

Phone number of the contact.

Maximum string length: 32
Pattern: ^(\+\d{1,2}\s?)?\(?\d{3}\)?[\s.-]?\d{3}[\s.-]?\d{4}$
Example:

"1234567890"

​
tags
string[]

Tags that you want to associate with the contact.

Maximum string length: 32
Example:
["HOT LEAD"]
​
address
string

Property address to be associated with the contact.

Maximum string length: 256
​
crmFields
object
​
assignedUserEmailId
string

The email address of the user you want to assign to a contact.

Pattern: ^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
Example:

"tim@example.com"

Response

Success

​
contact
object
​
warnings
enum<string>[]
Available options:
InvalidInputAddress