Ler um lote de campanhas

Este ponto de extremidade lê um lote de campanhas com base nos dados de entrada fornecidos e retorna as campanhas junto com seus ativos associados. O número máximo de itens em uma solicitação em lote é 50. Não há garantia de que as campanhas na resposta estarão na mesma ordem em que foram fornecidas na solicitação. Se IDs de campanha duplicados forem fornecidos na solicitação, os itens duplicados serão ignorados. A resposta incluirá apenas IDs exclusivos e será retornada sem itens duplicados.

POST /marketing/v3/campaigns/batch/read

Ler um lote de campanhas

cURL

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>"
    }
  ]
}
'

200

{
  "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",
  "status": "CANCELED",
  "errors": [
    {
      "category": "<string>",
      "context": {},
      "errors": [
        {
          "message": "<string>",
          "code": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "in": "<string>",
          "subCategory": "<string>"
        }
      ],
      "links": {},
      "message": "<string>",
      "status": "<string>",
      "id": "<string>",
      "subCategory": {}
    }
  ],
  "links": {},
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.

Marketing Hub -Professional

Sales Hub -Grátis

Service Hub -Grátis

Content Hub -Grátis

Escopos Necessários

Autorizações

oauth2private_apps

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

properties · string[]

startDate · string

Corpo

application/json

inputs · object[] · obrigatório

Show child attributes

Resposta

200

application/json

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

Show child attributes

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

errors · object[]

Show child attributes

links · object

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

Show child attributes

numErrors · integer<int32>

requestedAt · string<date-time>

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