v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB
Batch

Read a batch of campaigns

This endpoint reads a batch of campaigns based on the provided input data and returns the campaigns along with their associated assets. The maximum number of items in a batch request is 50. The campaigns in the response are not guaranteed to be in the same order as they were provided in the request. If duplicate campaign IDs are provided in the request, duplicates will be ignored. The response will include only unique IDs and will be returned without duplicates.

post/marketing/campaigns/2026-03/batch/read

Query parameters

endDatestring

End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched. Example: 2024-01-27

propertiesstring[]

A comma-separated list of the properties to be returned in the response. If any of the specified properties has empty value on the requested object(s), they will be ignored and not returned in response. If this parameter is empty, the response will include an empty properties map. Example: hs_name, hs_campaign_status, hs_notes

startDatestring

Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched. Example: 2023-01-20

Request body

Response

successful operation

completedAtstring date-time required

The timestamp when the batch request processing was completed.

linksobject

A collection of URLs linking to related resources or documentation.

requestedAtstring date-time

The timestamp when the batch request was initially made.

startedAtstring date-time required

The timestamp when the processing of the batch request began.

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

The current processing status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.