Pular para o conteúdo principal
POST
/
marketing
/
v3
/
campaigns
/
batch
/
read
Ler um lote de campanhas
curl --request POST \
  --url https://api.hubapi.com/marketing/v3/campaigns/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    {
      "id": "<string>"
    }
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "assets": {},
      "businessUnits": [
        {
          "id": 123
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

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

endDate
string

Data de término para buscar métricas de ativos, formatada como AAAA-MM-DD. Esta data é usada para buscar as métricas associadas aos ativos para um período especificado. Se não for fornecida, nenhuma métrica de ativo será buscada. Exemplo: 2024-01-27

properties
string[]

Uma lista separada por vírgulas das propriedades a serem retornadas na resposta. Se alguma das propriedades especificadas tiver valor vazio no(s) objeto(s) solicitado(s), ela será ignorada e não será retornada na resposta. Se este parâmetro estiver vazio, a resposta incluirá um mapa de propriedades vazio. Exemplo: hs_name, hs_campaign_status, hs_notes

startDate
string

Data de início para buscar métricas de ativos, formatada como AAAA-MM-DD. Esta data é usada para buscar as métricas associadas aos ativos para um período especificado. Se não for fornecida, nenhuma métrica de ativo será buscada. Exemplo: 2023-01-20

Corpo

application/json
inputs
object[]
obrigatório

Uma matriz de objetos PublicCampaignReadInput, cada um contendo o ID de uma campanha a ser lida. Esta propriedade é obrigatória.

Resposta

successful operation

completedAt
string<date-time>
obrigatório

A data e a hora em que o processamento da solicitação em lote foi concluído.

results
object[]
obrigatório

Uma matriz de resultados da operação em lote. Cada um deles representa uma campanha pública com ativos.

startedAt
string<date-time>
obrigatório

A data e a hora em que o processamento da solicitação em lote começou.

status
enum<string>
obrigatório

O status de processamento atual da operação em lote. Os valores possíveis são: CANCELADO, CONCLUÍDO, PENDENTE, PROCESSANDO.

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

Uma coleção de URLs com links para recursos ou documentação relacionados.

requestedAt
string<date-time>

A data e a hora em que a solicitação em lote foi feita inicialmente.

Last modified on May 11, 2026