Pular para o conteúdo principal
PATCH
Atualizar

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

postalMailId
string
obrigatório
Pattern: .+

Parâmetros de consulta

idProperty
string

O nome de uma propriedade cujos valores são exclusivos para este tipo de objeto

Corpo

application/json

Representa a entrada necessária para atualizar um objeto do CRM, contendo um objeto com nomes de propriedades e seus valores correspondentes.

properties
object
obrigatório

Um objeto que contém pares chave-valor, em que cada chave é um nome de propriedade e o valor é o valor da propriedade. Todas as propriedades são strings.

Resposta

successful operation

Um objeto público simples.

archived
boolean
obrigatório

Um booleano que indica se o objeto está arquivado.

createdAt
string<date-time>
obrigatório

A data e a hora em que este objeto foi criado, no formato ISO 8601.

id
string
obrigatório

O identificador exclusivo para este objeto, representado como uma string.

properties
object
obrigatório

Um mapa de nomes de propriedades para seus valores, em que cada valor é uma string.

updatedAt
string<date-time>
obrigatório

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

archivedAt
string<date-time>

A data e a hora em que este objeto foi arquivado, no formato ISO 8601.

objectWriteTraceId
string

Um identificador usado para rastrear a solicitação de criação ou atualização do objeto do CRM.

propertiesWithHistory
object

Mapa de nomes de propriedades para matrizes de seus valores históricos, cada entrada contendo um valor e data/hora.

url
string

Uma string que representa a URL do objeto.

warnings
object[]

Uma matriz de avisos relacionados ao objeto, cada um contendo uma categoria, mensagem e contexto.

Última modificação em 6 de outubro de 2026