Skip to main content
POST
Fazer upsert de assinatura

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
actions
enum<string>[]
obrigatório

Uma matriz de strings que especifica as ações que acionam o gatilho da assinatura. Os gatilhos válidos incluem "CREATE", "UPDATE", "DELETE", "MERGE", "RESTORE".

Opções disponíveis:
CREATE,
UPDATE,
DELETE,
MERGE,
RESTORE,
ASSOCIATION_ADDED,
ASSOCIATION_REMOVED,
SNAPSHOT,
APP_INSTALL,
APP_UNINSTALL,
ADDED_TO_LIST,
REMOVED_FROM_LIST,
GDPR_DELETE
objectIds
integer<int64>[]
obrigatório

Uma matriz de números inteiros que representa os IDs dos objetos envolvidos na assinatura. Vazio significa acompanhar todos os objectIds.

objectTypeId
string
obrigatório

Uma string que identifica o tipo de objeto para o qual a assinatura está sendo criada ou atualizada. Por exemplo, "0-1" para contatos.

portalId
integer<int64>
obrigatório

Um número inteiro que representa o ID do portal associado à assinatura.

properties
string[]
obrigatório

Uma matriz de strings listando as propriedades dos objetos que são relevantes para a assinatura. Vazio significa acompanhar todas as propriedades.

subscriptionType
enum<string>
padrão:OBJECT
obrigatório

Uma string que indica o tipo de assinatura. O valor padrão e único válido é 'OBJETO'.

Opções disponíveis:
OBJECT

Resposta

successful operation

actions
enum<string>[]
obrigatório

Uma lista de ações que acionam a assinatura. Os valores possíveis incluem "CREATE", "UPDATE", "DELETE", "MERGE", "RESTORE", "ASSOCIATION_ADDED", "ASSOCIATION_REMOVED", "SNAPSHOT", "APP_INSTALL", "APP_UNINSTALL", "ADDED_TO_LIST", "REMOVED_FROM_LIST" e "GDPR_DELETE".

Opções disponíveis:
CREATE,
UPDATE,
DELETE,
MERGE,
RESTORE,
ASSOCIATION_ADDED,
ASSOCIATION_REMOVED,
SNAPSHOT,
APP_INSTALL,
APP_UNINSTALL,
ADDED_TO_LIST,
REMOVED_FROM_LIST,
GDPR_DELETE
appId
integer<int64>
obrigatório

O identificador exclusivo do aplicativo associado à assinatura. É um número inteiro formatado como int64.

createdAt
string<date-time>
obrigatório

A data e hora em que a assinatura foi criada, no formato ISO 8601.

id
integer<int64>
obrigatório

O identificador exclusivo da assinatura. É um número inteiro formatado como int64.

objectTypeId
string
obrigatório

O identificador para o tipo de objeto associado à assinatura. É uma string.

subscriptionType
enum<string>
obrigatório

O tipo de assinatura, que pode ser um dos seguintes: "OBJECT", "ASSOCIATION", "EVENT", "APP_LIFECYCLE_EVENT", "LIST_MEMBERSHIP" ou "GDPR_PRIVACY_DELETION".

Opções disponíveis:
APP_LIFECYCLE_EVENT,
ASSOCIATION,
EVENT,
GDPR_PRIVACY_DELETION,
LIST_MEMBERSHIP,
OBJECT
updatedAt
string<date-time>
obrigatório

A data e a hora da última atualização da assinatura, no formato ISO 8601.

actionOverrides
object

Um objeto que contém substituições de ação, em que cada chave é uma ação e o valor é um objeto ActionOverrideRequest.

associatedObjectTypeIds
string[]

Uma lista de IDs de tipo de objeto associados. Cada ID é uma string.

createdBy
integer<int64>

O ID do usuário que criou a assinatura. É um número inteiro formatado como int64.

deletedAt
string<date-time>

A data e a hora em que a assinatura foi excluída, no formato ISO 8601, se aplicável.

listIds
integer<int64>[]

Uma lista de IDs de lista associados à assinatura. Cada ID é um número inteiro formatado como int64.

objectIds
integer<int64>[]

Uma lista de IDs de objeto associados à assinatura. Cada ID é um número inteiro formatado como int64.

portalId
integer<int64>

O identificador exclusivo do portal associado à assinatura. É um número inteiro formatado como int64.

properties
string[]

Uma lista de nomes de propriedades associados à assinatura. Cada propriedade é uma string.

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