Update Contact
ploomes_contacts_updateIdempotent
Update specific fields of a Ploomes contact by ID. Only the fields you provide are changed; omitted fields stay the same.
Instructions
Update an existing contact in Ploomes CRM by ID. Only provided fields are changed; omitted fields remain untouched.
To find valid IDs for reference fields:
TypeId: use ploomes_contacts_types_list (typically 1=Person, 2=Company, but may vary per account)
StatusId: use ploomes_contacts_status_list to discover available contact statuses
OriginId: use ploomes_contacts_origins_list to discover available contact origins
OwnerId: use ploomes_users_list to discover valid user IDs
CityId: numeric city ID from the Ploomes cities database
CurrencyId: numeric currency ID from the Ploomes currencies list
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Contact ID to update. The unique numeric identifier of the contact in Ploomes. | |
| Name | No | Contact name. Full name for a person or company name. | |
| TypeId | No | Contact type ID. Use ploomes_contacts_types_list to discover valid values. Typically 1=Person, 2=Company, but values may vary per account. | |
| LegalName | No | Legal / registered company name. Useful for companies that have a trade name different from the legal name. | |
| Register | No | Tax identification number (CPF for individuals or CNPJ for companies in Brazil). | |
| IdentityDocument | No | Identity document number (e.g., RG in Brazil). | |
| No | Primary email address for the contact. | ||
| Phone | No | Primary phone number as a string. For multiple phones, use the Phones array instead. | |
| Phones | No | Array of phone numbers with type. Each entry has PhoneNumber (required), TypeId (optional), and CountryId (optional). | |
| StatusId | No | Contact status ID. Use ploomes_contacts_status_list to discover valid values for your account. | |
| CompanyId | No | Parent company contact ID. Links this person to a company contact already in Ploomes. | |
| OwnerId | No | Owner user ID. The user responsible for this contact. Use ploomes_users_list to discover valid user IDs. | |
| OriginId | No | Origin ID. How this contact was acquired. Use ploomes_contacts_origins_list to discover valid values. | |
| StreetAddress | No | Street address (street name). E.g.: "Rua Augusta" | |
| StreetAddressNumber | No | Street address number. E.g.: "1234" | |
| StreetAddressLine2 | No | Address complement / additional info. E.g.: "Sala 56", "Apto 12" | |
| Neighborhood | No | Neighborhood / district name. | |
| ZipCode | No | Zip / postal code (numeric only, formatting is stripped automatically). E.g.: "01310100" or "01310-100" | |
| CityId | No | City ID from the Ploomes cities database. Numeric identifier for the city. | |
| Note | No | Free-text note or general observations about the contact. | |
| Website | No | Website URL. E.g.: "https://www.example.com" | |
| Revenue | No | Annual revenue as a numeric value. | |
| Skype | No | Skype username or ID. | |
| No | Facebook profile URL or username. | ||
| Latitude | No | Geographic latitude coordinate. E.g.: -23.5505 | |
| Longitude | No | Geographic longitude coordinate. E.g.: -46.6333 | |
| CurrencyId | No | Currency ID for monetary values associated with this contact. | |
| EmailMarketing | No | Whether the contact has opted in to receive email marketing. true = opted in, false = opted out. | |
| OtherProperties | No | Custom field values. Use ploomes_fields_list to discover available fields. Each entry needs a FieldKey and exactly one value field (StringValue, IntegerValue, DateTimeValue, BoolValue, BigStringValue, or ObjectValueName). |