HUhubspot
Batch

Update a batch of communications by internal ID, or unique property values

Changed on

Update a batch of messages by ID (communicationId) or unique property value (idProperty). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.

post/crm/objects/2026-03/communications/batch/update

Request

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

Request body

Example request

{
  "inputs": [
    {
      "idProperty": "my_unique_property_name"
    }
  ]
}

Response

successful operation

completedAtstring date-time required

The timestamp when the batch processing 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 request was initially made, in ISO 8601 format.

startedAtstring date-time required

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

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

The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE"

Changes

  • b0d8bc008db9Revision changes
    • info

      api operation id post-/crm/objects/2026-03/communications/batch/update_update removed and replaced with post-/crm/objects/2026-03/communications/batch/update

  • e0403341222cRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the media type application/json for the response with the status

Some revisions have not been checked yet.