Batch

Perform a batch upsert operation on subscription objects.

Changed on

This endpoint allows you to perform a batch upsert operation on subscription objects, which will either update existing records or create new ones if they do not already exist. The operation returns the status, timestamps, and a list of successfully processed objects.

post/crm/objects/2026-03/subscriptions/batch/upsert

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/objects/2026-03/subscriptions/batch/upsert
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

Request body

Response

successful operation

completedAtstring date-time required

The timestamp when the batch process was completed, in ISO 8601 format.

linksobject

An object containing relevant links related to the batch request.

requestedAtstring date-time

The timestamp when the batch process was initiated, in ISO 8601 format.

startedAtstring date-time required

The timestamp when the batch process began execution, in ISO 8601 format.

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

The status of the batch processing request. Can be: "PENDING", "PROCESSING", "CANCELED", or "COMPLETE".

Changes

    • info

      the security scope crm.objects.listings.write was added to the endpoint's security scheme private_apps

    • info

      the security scope crm.objects.deals.highly_sensitive.write was removed from the endpoint's security scheme private_apps

    • info

      the security scope crm.objects.listings.write was added to the endpoint's security scheme private_apps

    • info

      the security scope crm.objects.deals.highly_sensitive.write was removed from the endpoint's security scheme private_apps

Some revisions have not been checked yet.