Batch

Batch update subscription status

Update the subscription status for a set of contacts.

post/communication-preferences/2026-03/statuses/batch/write

Request

Base URL
https://api.hubapi.com
Auth
- HTTP bearer
- or API key in query parameter hapikey
- or none
TypeScript
https://skmtc.dev/hubspot/apis/hubspot-api-specification/docs/communication-preferences/2026-03/statuses/batch/write/post.ts
A function with typed inputs. Its response is checked against the schema.

successful operation

completedAtstring date-time required

The date and time when the batch operation was completed.

linksobject

URLs linking to related resources or documentation.

numErrorsinteger

The number of errors encountered during the batch operation.

requestedAtstring date-time

The date and time when the request was made.

startedAtstring date-time required

The date and time when the batch operation started.

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

The current status of the batch operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.

Some revisions have not been checked yet.