POST/organizations/{organizationId}/contacts

Create a contact

Creates a contact and optionally associates it with tags and external identifiers.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL
Bearer tokenBearerAuthoptional
Stored only in this browser for the BearerAuth security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

organizationIdpath · stringrequired

Opaque organization identifier.

Idempotency-Keyheader · string · uuidoptional

Unique key for retry-safe writes, retained for 24 hours.

Request body

application/jsonrequired
emailstring · emailrequired
first_namestringoptional
last_namestringoptional
companystringoptional
lifecyclestringoptional
tagsarray<string>optional
traitsobjectoptional
consentobjectoptional

Responses

201application/json

Contact created.

{
  "id": "con_01J8FA5Q9M6T4X2K7P3",
  "email": "aleks@acme.example",
  "first_name": "Aleks",
  "last_name": "Nowak",
  "company": "Acme Studio",
  "lifecycle": "lead",
  "tags": [
    "webinar-september",
    "poland"
  ],
  "traits": {
    "plan_interest": "growth",
    "company_size": 48
  },
  "consent": {
    "marketing": true,
    "product_updates": true
  },
  "activity": {
    "event_count": 16,
    "last_seen_at": "2026-09-03T09:12:00Z"
  },
  "created_at": "2026-08-21T11:05:00Z",
  "updated_at": "2026-09-03T09:12:00Z"
}
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
companystringoptional
lifecyclestringoptional
tagsarray<string>optional
traitsobjectoptional
consentobjectoptional
activityobjectoptional
created_atstring · date-timeoptional
updated_atstring · date-timeoptional
409

Email already belongs to an existing contact.

Powered by heyo-docs