Saltar al contenido principal
POST
/
marketing
/
campaigns
/
2026-03
/
batch
/
read
Leer un lote de campañas
curl --request POST \
  --url https://api.hubapi.com/marketing/campaigns/2026-03/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

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de consulta

endDate
string

Fecha de finalización para obtener métricas de recursos, con el formato AAAA-MM-DD. Esta fecha se usa para obtener las métricas asociadas con los recursos durante un período específico. Si no se proporciona, no se obtendrán métricas de recursos. Ejemplo: 2024-01-27

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, se ignorarán y no se devolverán en la respuesta. Si este parámetro está vacío, la respuesta incluirá un mapa de propiedades vacío. Ejemplo: hs_name, hs_campaign_status, hs_notes

startDate
string

Fecha de inicio para obtener métricas de recursos, con el formato AAAA-MM-DD. Esta fecha se utiliza para obtener las métricas asociadas con los recursos durante un período específico. Si no se proporciona, no se obtendrán métricas de recursos. Ejemplo: 2023-01-20

Cuerpo

application/json
inputs
object[]
requerido

Un conjunto de objetos PublicCampaignReadInput, cada uno de los cuales contiene el ID de una campaña que se leerá. Esta propiedad es obligatoria.

Respuesta

successful operation

completedAt
string<date-time>
requerido

La marca de tiempo de cuando se completó el procesamiento de la solicitud por lotes.

results
object[]
requerido

Un conjunto de resultados de la operación por lotes, cada uno de los cuales representa una campaña pública con recursos.

startedAt
string<date-time>
requerido

La marca de tiempo de cuando comenzó el procesamiento de la solicitud por lotes.

status
enum<string>
requerido

El estado actual de procesamiento de la operación por lotes, con estos posibles valores: CANCELED, COMPLETE, PENDING, PROCESSING.

Opciones disponibles:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

Una recopilación de URL con enlaces a recursos o documentación relacionados.

requestedAt
string<date-time>

La marca de tiempo de cuando se realizó inicialmente la solicitud por lotes.

Última modificación el 13 de abril de 2026