Skip to main content
POST
/
client
/
contacts
Create a contact
curl --request POST \
  --url http://localhost:8080/api/v1/client/contacts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_contact_id": "crm-001",
  "company": "Acme Corp",
  "custom_fields": {},
  "email": "jane@example.com",
  "external_id": "crm-001",
  "first_name": "Jane",
  "is_subscribed": true,
  "last_name": "Doe",
  "last_purchase_at": "<string>",
  "phone": "+1-555-0100",
  "signup_source": "organic",
  "timezone": "America/New_York",
  "unsubscribe_reason": "<string>",
  "unsubscribed_at": "<string>"
}
'
{
  "data": {
    "active_states": 123,
    "active_workflow_count": 123,
    "client_contact_id": "<string>",
    "client_id": 123,
    "company": "<string>",
    "created_at": "<string>",
    "created_by": 123,
    "custom_fields": [
      123
    ],
    "email": "<string>",
    "external_id": "<string>",
    "first_name": "<string>",
    "health_score": 123,
    "id": 123,
    "is_subscribed": true,
    "last_activity_at": "<string>",
    "last_email_opened_at": "<string>",
    "last_name": "<string>",
    "last_purchase_at": "<string>",
    "last_workflow_at": "<string>",
    "phone": "<string>",
    "signup_source": "<string>",
    "tags": [
      "<string>"
    ],
    "timezone": "<string>",
    "total_emails_clicked": 123,
    "total_emails_opened": 123,
    "total_emails_sent": 123,
    "unsubscribe_reason": "<string>",
    "unsubscribed_at": "<string>",
    "updated_at": "<string>"
  },
  "errors": [
    {
      "condition": "format",
      "error": "Invalid email format",
      "key": "email"
    }
  ],
  "message": "Operation successful",
  "meta": {},
  "success": true
}

Authorizations

Authorization
string
header
required

JWT Bearer token or raw API key via Authorization header

Body

application/json

Contact data

client_contact_id
string
Example:

"crm-001"

company
string
Example:

"Acme Corp"

custom_fields
object
email
string
Example:

"jane@example.com"

external_id
string
Example:

"crm-001"

first_name
string
Example:

"Jane"

is_subscribed
boolean
last_name
string
Example:

"Doe"

last_purchase_at
string
phone
string
Example:

"+1-555-0100"

signup_source
string
Example:

"organic"

source
enum<string>

Source: accepted as string ("api", "import", "form", "app", "unknown") or integer (0-4).

Available options:
unknown,
api,
import,
form,
app
timezone
string
Example:

"America/New_York"

unsubscribe_reason
string
unsubscribed_at
string

Response

Created

data
object
errors
object[]
message
string
Example:

"Operation successful"

meta
object
success
boolean
Example:

true