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/v3/objects/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.

Example request

{
  "properties": {
    "property_checkbox": "false",
    "property_date": "1572480000000",
    "property_dropdown": "choice_b",
    "property_multiple_checkboxes": "chocolate;strawberry",
    "property_number": "17",
    "property_radio": "option_1",
    "property_string": "value"
  }
}

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.

Example response

{
  "archived": false,
  "createdAt": "2019-10-30T03:30:17.883Z",
  "id": "512",
  "properties": {
    "property_checkbox": "false",
    "property_date": "1572480000000",
    "property_dropdown": "choice_b",
    "property_multiple_checkboxes": "chocolate;strawberry",
    "property_number": "17",
    "property_radio": "option_1",
    "property_string": "value"
  },
  "updatedAt": "2019-12-07T16:50:06.678Z"
}

Changes

Changed in 7 of the 55 revisions of this API.29

Sep 2, 2026v3a7c9a1222f8b1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 13, 2026v36a1666da27ea1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 13, 2026v32531fcdcdc191See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 13, 2026v369b41e2497e31See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
Jun 23, 2026v32531fcdcdc191See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Apr 15, 2026v3aa87273c3f595See the full diff
- ○
  the endpoint scheme security app_cookie was removed from the API
  api-security-removed
- ○
  the endpoint scheme security hapikey was removed from the API
  api-security-removed
- ○
  the endpoint scheme security internal_cookie was removed from the API
  api-security-removed
- ○
  the endpoint scheme security private_apps was removed from the API
  api-security-removed
- ○
  the endpoint scheme security shhkey was removed from the API
  api-security-removed
Apr 13, 2026v3bc2405b1d51f1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history