Pular para o conteúdo principal
POST
Recupere um lote de objetos de assinatura por IDs.

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 consulta

archived
boolean
padrão:false

Se apenas os resultados que foram arquivados devem ser retornados.

Corpo

application/json

Especifica a entrada para a leitura de um lote de objetos do CRM, incluindo matrizes de IDs de objetos, nomes de propriedades solicitadas (com histórico opcional) e uma propriedade de identificação exclusiva opcional.

inputs
object[]
obrigatório

Matriz de objetos SimplePublicObjectId, cada um contendo um ID do objeto a ser lido. Esses IDs são usados para identificar objetos para os quais as propriedades e os valores históricos são solicitados.

properties
string[]
obrigatório

Uma matriz de strings que representam as propriedades a serem retornadas para cada objeto. Se algumas propriedades especificadas não estiverem presentes nos objetos solicitados, elas serão ignoradas.

propertiesWithHistory
string[]
obrigatório

Uma matriz de strings que representam as propriedades a serem retornadas junto com o histórico de seus valores anteriores. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, ela será ignorada.

idProperty
string

String que representa o nome de uma propriedade cujos valores são exclusivos para este tipo de objeto. É opcional e pode ser usado para identificar objetos por um valor de propriedade exclusivo em vez do ID interno.

Resposta

successful operation

Um objeto de resposta em lote de objeto público

completedAt
string<date-time>
obrigatório

A data e hora em que a operação em lote foi concluída, no formato ISO 8601.

results
object[]
obrigatório

Uma matriz de itens SimplePublicObject que representam os resultados da operação em lote.

startedAt
string<date-time>
obrigatório

A data e a hora em que a operação em lote foi iniciada, no formato ISO 8601.

status
enum<string>
obrigatório

O status atual da operação em lote. Os valores válidos incluem 'PENDENTE', 'PROCESSANDO', 'CANCELADO' e 'CONCLUÍDO'.

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

Um mapa de nomes de links para URIs associadas que fornecem contexto ou ações adicionais relacionadas à operação em lote.

requestedAt
string<date-time>

A data e a hora em que a operação em lote foi solicitada, no formato ISO 8601.

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