actionenumобязательный
The action to perform: "create", "update", or "delete".
addressstring | null
Street address (for create/update).
birthdaystring | null
Birthday as 'YYYY-MM-DD', 'MM-DD' (no year), or 'clear'/'' to remove.
contact_idstring | null
The contact ID. Required for "update" and "delete" actions.
emailstring | null
[DEPRECATED] Email address. Use emails=[{"address":..., "type":"other"}].
emailsobject[] | null
List of email dicts {address, type?}.
emails_modeenum
How to update emails on "update": "merge" (default), "replace", or "remove".
family_namestring | null
Last name (for create/update).
given_namestring | null
First name (for create/update).
job_titlestring | null
[DEPRECATED] Job title. Use organizations=[{"title":...}].
nicknamesobject[] | null
List of nickname dicts {value, type?}.
Useful for bilingual contacts (e.g. Hebrew/English alternative forms). Android dialer
and WhatsApp search both index nicknames, enabling cross-script lookup.
Supported types: default, alternate_name, maiden_name, initials, other, etc.
nicknames_modeenum
How to update nicknames on "update": "merge" (default), "replace", or "remove".
notesstring | null
Additional notes (for create/update).
organizationstring | null
[DEPRECATED] Company name. Use organizations=[{"name":...}].
organizationsobject[] | null
List of org dicts {name?, title?, department?, jobDescription?, type?}.
organizations_modeenum
How to update orgs on "update": "merge" (default), "replace", or "remove".
phonestring | null
[DEPRECATED] Single phone number. Use phones=[{"number":..., "type":"mobile"}].
phonesobject[] | null
List of phone dicts {number, type?}.
Supported types: mobile, work, home, main, workMobile, internal, other, etc.
Use type="internal" for internal PBX/ATS short numbers (e.g. 250, 301) — stored
as a standalone number without + prefix, displayed as "Internal: 250".
phones_modeenum
How to update phones on "update": "merge" (default), "replace", or "remove".
merge = read-modify-write with dedup by canonicalForm/normalized value.
replace = overwrite all phones with provided list.
remove = delete phones matching provided numbers.
relationsobject[] | null
List of relation dicts {person, type?}.
Supported types: spouse, child, parent, friend, manager, assistant, etc.
relations_modeenum
How to update relations on "update": "merge" (default), "replace", or "remove".
urlsobject[] | null
List of URL dicts {value, type?}.
Supported types: homepage, blog, profile, work, ftp, reservations, other, etc.
urls_modeenum
How to update urls on "update": "merge" (default), "replace", or "remove".
merge dedups by normalized URL (lowercased, trailing slash stripped).
user_definedobject[] | null
List of custom field dicts {key, value}.
Useful for structured data like account numbers, IDs, or custom dates.
user_defined_modeenum
How to update custom fields on "update": "merge" (default), "replace", or "remove".
merge overrides value on matching key; new keys appended.
user_google_emailstringобязательный
The user's Google email address. Required.
