Skip to content

update_contact

Partially update a contact. Pass only the fields you want to change. Set a nullable field to null to clear it. At least one trait or external_user_id must be present.

required scope: read:write.

  • “update ctc_01H8…‘s plan to Enterprise and bump mrr_cents to 99000.”
  • “clear the external_user_id on this contact — they cancelled and the link is no longer valid.”
fieldtyperequirednotes
contact_idstringyes
external_user_idstring (max 255 chars) | unknown | nullno
emailstring (max 320 chars) | unknown | nullno
namestring (max 200 chars) | unknown | nullno
planstring (max 100 chars) | unknown | nullno
mrr_centsinteger (0-100,000,000) | unknown | nullno
currencystring (regex) | unknown | nullno
metadataobjectno
  • mrr_cents and currency must be cleared together; clearing one without the other is rejected.
  • Field constraints match create_contact: mrr_cents ≤ 100,000,000; email ≤ 320 chars; metadata ≤ 100 keys.

The updated contact row.