Skip to main content
PATCH
Update a subscription.

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

subscriptionId
string
required
Pattern: .+

Query Parameters

idProperty
string

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

Body

application/json

Represents the input required to update a CRM object, containing an object with property names and their corresponding values.

properties
object
required

An object containing key-value pairs where each key is a property name and each value is the property's new value. All provided properties will be updated on the object.

Response

successful operation

A simple public object.

archived
boolean
required

A boolean indicating whether this object has been archived.

createdAt
string<date-time>
required

The date and time when this object was created, in ISO 8601 format.

id
string
required

The unique identifier for this object, represented as a string.

properties
object
required

A map of property names to their values, where each value is a string.

updatedAt
string<date-time>
required

The date and time when this object was last updated, in ISO 8601 format.

archivedAt
string<date-time>

The date and time when this object was archived, in ISO 8601 format.

objectWriteTraceId
string

A string representing the trace ID for write operations on this object.

propertiesWithHistory
object

A map of property names to arrays of historical values, where each value includes a timestamp and the source of the value.

url
string

A string containing the URL associated with this object.

warnings
object[]

An array of warnings related to this object, each containing a category, message, and context.

Last modified on September 14, 2026