v4

latestOpenAPI 3.0.12026-07-13113470.7 KB

Basic

Update

Perform a partial update of an Object identified by {commercePaymentId}or optionally a unique property value as specified by the idProperty query param. {commercePaymentId} 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-09/{objectType}/{objectId}

Path parameters

objectIdstring required

The CRM object type corresponding to the data being updated. This is COMMERCE_PAYMENT or 0-101

objectTypestring required

The crm record ID of the payment to be queried. Equivalent to hs_object_id

Query parameters

idPropertystring

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

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.