Sign in

v7

latestOpenAPI 3.0.12026-07-131134150.6 KB
Basic

Update a subscription

Update a specific subscription by its ID with new property values.

patch/crm/objects/2026-09/{objectType}/{objectId}

Path parameters

objectIdstring required

Subscription Object Id

objectTypestring required

Object type.

Query parameters

idPropertystring

The name of a unique identifier property, which can be used for identifying objects instead of the object ID.

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.