Skip to main content
POST
/
v1
/
contacts
Create Contact
curl --request POST \
  --url http://localhost:4000/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com",
  "phoneNumber": "+15551234567",
  "status": "POTENTIAL",
  "tag": "lead-2024",
  "joinedTime": "2024-01-15T10:00:00.000Z",
  "eventName": "Product Demo",
  "utm": "utm_source=google&utm_medium=cpc",
  "country": "US",
  "timeZone": "America/New_York",
  "ipAddress": "192.168.1.1",
  "referrerUrl": "https://example.com/signup"
}
'
{
  "data": {
    "contact": {
      "id": 123,
      "accountId": 123,
      "userId": 123,
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "status": "<string>",
      "phoneNumber": "<string>",
      "previewId": "<string>",
      "tagId": 123,
      "blockedByRecaptcha": true,
      "joinedTime": "<string>",
      "country": "<string>",
      "timeZone": "<string>",
      "ipAddress": "<string>",
      "blockedId": 123,
      "referrerUrl": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>",
      "tracking": {}
    }
  }
}

Authorizations

​
Authorization
string
header
required

API key required in Authorization header. Format: iclosed-<token>

Body

application/json
​
firstName
string
Maximum string length: 25
​
lastName
string
Maximum string length: 25
​
email
string<email>
Maximum string length: 255
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
​
phoneNumber
string
Maximum string length: 20
Pattern: ^\+?\d+$
​
status
enum<string>
Available options:
POTENTIAL,
QUALIFIED,
DISQUALIFIED
​
tag
string
Maximum string length: 100
​
joinedTime
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
eventName
string
Maximum string length: 255
​
utm
string
Maximum string length: 1000
​
country
string
Maximum string length: 2
​
timeZone
string
Maximum string length: 50
​
ipAddress
string
Maximum string length: 45
​
referrerUrl
string<uri>
Maximum string length: 500

Response

Successfully created contact

​
data
object
required