Skip to main content
POST
/
marketing
/
v3
/
campaigns
/
batch
/
read
Leer un lote de campañas
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",
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "businessUnits": [
        {
          "id": 123
        }
      ],
      "assets": {},
      "id": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "status": "PENDING"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Pro
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito
Esta API requiere uno de los siguientes ámbitos:
marketing.campaigns.read

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
startDate
string

Fecha de inicio para obtener métricas de recursos, con el formato AAAA-MM-DD. Esta fecha se utiliza para buscar las métricas asociadas con los recursos durante un período específico. Si no se suministra, no se buscan métricas de recursos.

​
endDate
string

Fecha de finalización para obtener métricas de recursos, con el formato AAAA-MM-DD. Esta fecha se utiliza para buscar las métricas asociadas con los recursos durante un período específico. Si no se suministra, no se buscan métricas de recursos.

​
properties
string[]

Una lista separada por comas de las propiedades que se devolverán en la respuesta. Si alguna de las propiedades especificadas tiene un valor vacío en los objetos solicitados, serán ignoradas y no se mostrarán en la respuesta. Si este parámetro está vacío, la respuesta incluirá un mapa de propiedades vacío.

Body

application/json
​
inputs
object[]
required

Response

successful operation

​
completedAt
string<date-time>
required
​
startedAt
string<date-time>
required
​
results
object[]
required
​
status
enum<string>
required
Available options:
PENDING,
PROCESSING,
CANCELED,
COMPLETE
​
requestedAt
string<date-time>
​
links
object