Contacts Tools

Update Contact

Update a person or organization identified by contact_code. If only a name, email, phone, CPF, or CNPJ is known, use search_contacts first to obtain the code required by the path. Selector fields such as contact_email identify the record; fields such as email contain the new value. Only provided update fields are changed. Write operation: modifies a contact.

put/v1/mcp/tool/contact/{contact_code}

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/mcp/tool/contact/{contact_code}
  • Auth: API key in header X-Imobzi-Secret

Path parameters

contact_codestring required

Public contact code placed in the request path. It is the primary selector and takes priority over email, name, phone, or CPF/CNPJ when it resolves to a contact. Preserve the code returned by search_contacts.

Request body

contact_codestring nullable

Public contact code placed in the request path. It is the primary selector and takes priority over email, name, phone, or CPF/CNPJ when it resolves to a contact. Preserve the code returned by search_contacts.

contact_emailstring nullable

Fallback selector for the existing contact, used only when contact_code does not resolve. Exact email, case-insensitive. This field identifies the existing record; use email for the new value.

contact_namestring nullable

Fallback selector for the existing contact, used only when contact_code does not resolve. It must identify exactly one person or organization. This field identifies the existing record; use fullname, firstname, lastname, or organization_name for the new name.

contact_phonestring nullable

Fallback selector for the existing contact, used only when contact_code does not resolve. Formatting is ignored and the phone must contain at least eight digits. This field identifies the existing record; use phone for the new value.

contact_legal_identificationstring nullable

Fallback selector for the existing contact, used only when contact_code does not resolve. Accepts CPF or CNPJ with or without formatting. This field identifies the existing record; use cpf or cnpj for the new value.

firstnamestring nullable

New first name for a person. Prefer fullname when the complete new name is known.

lastnamestring nullable

New surname for a person. Preserve particles such as 'das', 'de', and 'dos'.

fullnamestring nullable

New complete name for a person. Prefer this field over manually splitting the value into firstname and lastname.

organization_namestring nullable

New name for an organization contact. Use fullname for a person contact.

emailstring nullable

New primary email for the contact. This is an update value; contact_email is only a fallback selector for the existing record.

phonestring nullable

New primary phone for the contact. Punctuation is removed and at least eight digits are required. contact_phone is only a fallback selector.

cpfstring nullable

New CPF for a person, with or without formatting. The check digits are validated.

cnpjstring nullable

New CNPJ for an organization, with or without formatting. The check digits are validated.

tagsstring[] nullable

Replacement tag list for the contact.

activeboolean nullable

Set true to activate or false to deactivate the contact.

favoriteboolean nullable

Set true to mark or false to unmark the contact as a favorite.

manager_namestring nullable

Name or partial name of the manager to assign to the contact. The lookup is case-insensitive and must resolve to one active user; otherwise the tool returns options for disambiguation. Omit both manager fields; creation then assigns the requesting user, while update keeps the current manager.

manager_emailstring nullable

Exact email of the new responsible manager. Prefer this over manager_name when available. Omit both manager fields to keep the current manager.

birthdaystring nullable

New birthday for a person. Accepted formats: YYYY-MM-DD, DD/MM/YYYY, or DD-MM-YYYY.

addressstring nullable

New address for the contact as free text.

observationstring nullable

New free-text note about the contact.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.