Basic

Update a subscription.

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

patch/crm/objects/2026-03/subscriptions/{subscriptionId}

Request

subscriptionIdstring required

idPropertystring

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

propertiesobject required

Key value pairs representing the properties of the object.

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.

Apr 8, 2026b0d8bc008db9 Revision changes
- info
  the security scope crm.objects.listings.write was added to the endpoint's security scheme private_apps
- info
  the security scope crm.objects.deals.highly_sensitive.write was removed from the endpoint's security scheme private_apps
Apr 3, 20263578967e48df Revision changes
- info
  the security scope crm.objects.listings.write was added to the endpoint's security scheme private_apps
- info
  the security scope crm.objects.deals.highly_sensitive.write was removed from the endpoint's security scheme private_apps

Some revisions have not been checked yet.