Batch

Batch assign members

Assign multiple members to a specific team in a single request. This endpoint allows for efficient management of team memberships by processing multiple assignments at once. It is useful for organizations looking to streamline their team management processes.

post/settings/teams/2026-09/{teamId}/members/batch

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/settings/teams/2026-09/{teamId}/members/batch
  • Auth: OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: settings.users.teams.write)

Path parameters

teamIdstring required

The unique identifier of the team to which members will be assigned.

Request body

Response

successful operation

completedAtstring date-time required

The date and time when the batch operation was completed, in ISO 8601 format.

linksobject

A map of link names to associated URIs providing additional information about the batch operation.

numErrorsinteger

The number of errors encountered during the batch operation.

requestedAtstring date-time

The date and time when the batch operation was requested, in ISO 8601 format.

startedAtstring date-time required

The date and time when the batch operation started, in ISO 8601 format.

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

The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.

Changes

No recorded changes to this operation across all 1 revision of this API.