Pular para o conteúdo principal
POST
Recuperar cursos em lote

Supported products

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

Uma matriz de objetos SimplePublicObjectId, cada um representando um ID de objeto para o qual a operação de leitura em lote será realizada.

properties
string[]
obrigatório

Uma matriz de strings que especifica as propriedades a serem retornadas na resposta. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, ela será ignorada.

propertiesWithHistory
string[]
obrigatório

Matriz de strings que especificam 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

Uma string que representa o nome de uma propriedade cujos valores são exclusivos para este tipo de objeto.

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 representando 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, fornecendo recursos ou informaçõ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