Sign in
Subscriptions

Update an event subscription

Update an existing event subscription by ID.

patch/webhooks/v3/{appId}/subscriptions/{subscriptionId}

Path parameters

appIdinteger required

The ID of the app.

subscriptionIdinteger required

The ID of the event subscription.

Request body

activeboolean

Determines if the subscription is active or paused.

Example request

{
  "active": true
}

Response

successful operation

activeboolean required

Determines if the subscription is active or paused.

createdAtstring date-time required

When this subscription was created. Formatted as milliseconds from the Unix epoch.

eventType'company.associationChange' | 'company.creation' | 'company.deletion' | 'company.merge' | 'company.propertyChange' | 'company.restore' | 'contact.associationChange' | 'contact.creation' | 'contact.deletion' | 'contact.merge' | 'contact.privacyDeletion' | 'contact.propertyChange' | 'contact.restore' | 'conversation.creation' | 'conversation.deletion' | 'conversation.newMessage' | 'conversation.privacyDeletion' | 'conversation.propertyChange' | 'deal.associationChange' | 'deal.creation' | 'deal.deletion' | 'deal.merge' | 'deal.propertyChange' | 'deal.restore' | 'line_item.associationChange' | 'line_item.creation' | 'line_item.deletion' | 'line_item.merge' | 'line_item.propertyChange' | 'line_item.restore' | 'object.associationChange' | 'object.creation' | 'object.deletion' | 'object.merge' | 'object.propertyChange' | 'object.restore' | 'product.creation' | 'product.deletion' | 'product.merge' | 'product.propertyChange' | 'product.restore' | 'ticket.associationChange' | 'ticket.creation' | 'ticket.deletion' | 'ticket.merge' | 'ticket.propertyChange' | 'ticket.restore' required

Type of event to listen for. Can be one of create, delete, deletedForPrivacy, or propertyChange.

idstring required

The unique ID of the subscription.

objectTypeIdstring

The identifier of the object type associated with the subscription.

propertyNamestring

The internal name of the property being monitored for changes. Only applies when eventType is propertyChange.

updatedAtstring date-time

When this subscription was last updated. Formatted as milliseconds from the Unix epoch.

Changes