PATCH/io/contacts/contacts/:id

Updates the specified fields on a contact. Only provided fields are changed.

Path parameters

idstringpathrequired

The contact UUID.

Request body — all fields optional

firstNamestringbody

First name (max 100 chars).

lastNamestringbody

Last name (max 100 chars).

phonestringbody

Phone number including country code (max 50 chars).

companystringbody

Company or organisation name (max 150 chars).

jobTitlestringbody

Job title / designation (max 100 chars).

socialProfilesobjectbody

Replaces the entire social profiles map. Allowed keys: linkedin, twitter, instagram, telegram, whatsapp, reddit, youtube. Unknown keys are dropped.

statusstringbody

subscribed | unsubscribed | bounced | complained.

customFieldsobjectbody

Replaces the entire custom_fields map (max 20 keys, 8 KB).

sourcestringbody

Acquisition source (max 100 chars).

{
  "phone": "+44 20 7946 0958",
  "company": "New Employer Ltd",
  "jobTitle": "Senior PM",
  "socialProfiles": {
    "linkedin": "https://linkedin.com/in/bobsmith",
    "twitter": "@bobsmith",
    "telegram": "@bob_smith"
  }
}

{
  "data": {
    "id": "cnt_abc123",
    "phone": "+44 20 7946 0958",
    "company": "New Employer Ltd",
    "job_title": "Senior PM",
    "social_profiles": {
      "linkedin": "https://linkedin.com/in/bobsmith",
      "twitter": "@bobsmith",
      "telegram": "@bob_smith"
    },
    "status": "subscribed",
    "...": "..."
  }
}

Error cases

Code	Error
400	`No updatable fields provided`
400	`phone must be 50 characters or fewer` (and similar for other fields)
400	`status must be subscribed, unsubscribed, bounced, or complained`
404	`Contact not found`
429	`Too many requests` — 200 writes per user per 60 seconds

Update Contact