Update a communication
Perform a partial update of an object identified by {objectId}. By default, {objectId} refers to the internal object ID, but you can specify any unique property value using the idProperty query parameter. The provided property values will overwrite existing ones, while read-only and non-existent properties will be ignored. To clear a property value, pass an empty string.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
.+Query Parameters
The name of a property whose values are unique for this object type
Body
Represents the input required to update a CRM object, containing an object with property names and their corresponding values.
An object containing key-value pairs representing the properties of the CRM object. Each key is a property name, and each value is a string representing the property's value.
Response
successful operation
A simple public object.
A boolean indicating whether this object is archived.
The date and time when this object was created, in ISO 8601 format.
The unique identifier for this object, represented as a string.
A map of property names to their values, where each value is a string.
The date and time when this object was last updated, in ISO 8601 format.
The date and time when this object was archived, in ISO 8601 format.
A string identifier used for tracing write operations on this object.
A map of property names to arrays of historical values, where each value includes a timestamp and source information.
A string representing the URL associated with this object.
An array of warnings related to this object, where each warning includes a category, message, and context.