Sign in
Basic

Update

Perform a partial update of an Object identified by {communicationId}or optionally a unique property value as specified by the idProperty query param. {communicationId} refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.

patch/crm/objects/2026-03/communications/{communicationId}

Path parameters

communicationIdstring required

Query parameters

idPropertystring

The name of a property whose values are unique for this object type

Request body

propertiesobject required

Key value pairs representing the properties of the object.

Response

successful operation

archivedboolean required

Whether the object is archived.

archivedAtstring date-time

The timestamp when the object was archived, in ISO 8601 format.

createdAtstring date-time required

The timestamp when the object was created, in ISO 8601 format.

idstring required

The unique ID of the object.

objectWriteTraceIdstring

An identifier used for tracing the write request for the object.

propertiesobject required

Key-value pairs representing the properties of the object.

propertiesWithHistoryobject

Key-value pairs representing the properties of the object along with their history.

updatedAtstring date-time required

The timestamp when the object was last updated, in ISO 8601 format.

urlstring

The URL associated with the object.

Changes

Changed in 3 of the 14 revisions of this API.3

  • b0d8bc008db91See the full diff
    • ○

      api operation id patch-/crm/objects/2026-03/communications/{communicationId}_update removed and replaced with patch-/crm/objects/2026-03/communications/{communicationId}

      api-operation-id-removed

    This revision also has 77 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dc2fdad57f7f1See the full diff
    • ○

      api operation id patch-/crm/objects/2026-03/communications/{communicationId}_/crm/objects/2026-03/communications/{communicationId} removed and replaced with patch-/crm/objects/2026-03/communications/{communicationId}_update

      api-operation-id-removed

    This revision also has 129 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 62586336cea21See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 73 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 14 revisions, 1 has no diff computed and 2 have a changelog that could not be searched.