Pular para o conteúdo principal
PATCH
Atualizar uma assinatura de evento

Supported products

Autorizações

hapikey
string
query
obrigatório

Parâmetros de caminho

appId
integer<int32>
obrigatório

O ID do aplicativo de destino.

subscriptionId
integer<int32>
obrigatório

O ID da assinatura para atualizar.

Corpo

application/json

Updated details for the subscription.

Updated details for the subscription.

active
boolean

Um booleano que indica se a assinatura do webhook deve ser ativada ou pausada. Se for "true", a assinatura enviará notificações de webhook. Se for "false", a assinatura será pausada e não enviará notificações.

Resposta

successful operation

Complete details for an event subscription.

active
boolean
obrigatório

Indica se a assinatura está ativa ou pausada. Se for "true", a assinatura enviará notificações de webhook. Se for "false", a assinatura será pausada e não enviará notificações.

createdAt
string<date-time>
obrigatório

A data/hora em que a assinatura do webhook foi criada, no formato ISO 8601 (por exemplo, 2020-02-29T12:30:00Z).

eventType
enum<string>
obrigatório

O tipo de evento a ser monitorado. Os valores aceitos incluem contact.creation, contact.deletion, contact.propertyChange e tipos de eventos semelhantes para outros objetos do CRM e objetos personalizados.

Opções disponíveis:
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,
event.completed,
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
id
string
obrigatório

O ID exclusivo da assinatura do webhook.

eventTypeName
string

O nome do evento a ser monitorado. Isso é usado com objetos personalizados para especificar tipos de eventos personalizados além dos valores padrão de enumeração eventType.

objectTypeId
string

O ID do objeto para a assinatura. Pode ser um objeto dp CRM padrão (por exemplo, "contato", "registro de empresa", "negócio") ou um ID de objeto personalizado para assinaturas de objetos personalizados.

propertyName
string

O nome interno da propriedade a ser monitorada quanto a alterações. Somente se aplica quando eventType é propertyChange.

updatedAt
string<date-time>

A data/hora da última atualização da assinatura do webhook, no formato ISO 8601 (por exemplo, 2020-02-29T12:30:00Z).

Última modificação em 13 de abril de 2026