Pular para o conteúdo principal
POST
Ler um lote de propriedades

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

objectType
string
obrigatório

O tipo de objeto do CRM para o qual as propriedades estão sendo recuperadas. Este é um parâmetro de caminho obrigatório.

Parâmetros de consulta

locale
string

String que especifica o local a ser usado para a resposta. Isso pode ser usado para direcionar a resposta a um idioma ou região específica.

Corpo

application/json
archived
boolean
obrigatório

Especifica se a propriedade está arquivada.

dataSensitivity
enum<string>
obrigatório

Indica o nível de confidenciaidade dos dados, como "non_sensitive", "sensitive" ou "highly_sensitive".

Opções disponíveis:
highly_sensitive,
non_sensitive,
sensitive
inputs
object[]
obrigatório

Matriz de nomes de propriedades a serem incluídos na operação de leitura em lote. Cada item na matriz é uma referência a um objeto PropertyName.

Resposta

successful operation

completedAt
string<date-time>
obrigatório

A data e a hora que indica quando a operação em lote foi concluída.

results
object[]
obrigatório

Matriz de objetos de propriedade que representa resultados da operação em lote.

startedAt
string<date-time>
obrigatório

A data/hora que indica quando a operação em lote começou a ser processada.

status
enum<string>
obrigatório

O status atual da operação em lote. Os valores possíveis são: CANCELED, COMPLETE, PENDING ou PROCESSING.

Opções disponíveis:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

Uma coleção de URLs que direcionam para a documentação ou para recursos relacionados à operação em lote.

requestedAt
string<date-time>

A data e a hora que indica quando a operação em lote foi solicitada.

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