HubSpot: Batch assign members

← Teams operations · Get started

Operation hubspot.teams_batch_add_team_members

Provider route: POST /settings/teams/2026-09/{teamId}/members/batch. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["teams"]["batchAddTeamMembers"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.teams.batchAddTeamMembers(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.teams.batch_add_team_members(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.teamId	string	Required within parent
body	Model	Required within parent	Expand Batch assign members — request body — body

Referenced models: Batch assign members — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Batch assign members — response body

Referenced models: Batch assign members — response body

Schemas

Batch assign members — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of team member assignments, where each item specifies the details of a team member to be assigned. Each item is of type 'TeamMemberAssignment'.
inputs[]	Model	Each item	Expand Add Team Members — request body — body

Referenced models: Add Team Members — request body — body

Batch assign members — response body

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of StandardError objects detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Batch assign members — response body — errors item
links	object	Optional	A map of link names to associated URIs providing additional information about the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of TeamMemberResponse objects representing the results of the batch operation.
results[]	Model	Each item	Expand Add Team Members — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Add Team Members — response body, Batch assign members — response body — errors item

Add Team Members — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	The type of team member assignment. It is a string and can be either 'DEFAULT' or 'EXTRA'. One of: DEFAULT, EXTRA
userId	string	Required within parent	The unique identifier for the user being assigned to the team. It is a string.

Add Team Members — response body

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	The type of membership the user has in the team. Valid values are 'DEFAULT' and 'EXTRA'. Known values: DEFAULT, EXTRA
userId	string	Required within parent	The unique identifier for the user, represented as a string.

Batch assign members — response body — errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	A string representing the category of the error.
context	object	Required within parent	An object containing additional context about the error condition, with keys as context names and values as arrays of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about the error.
errors[]	Model	Each item	Expand Batch assign members — response body — errors item errors item
id	string	Optional	A string that uniquely identifies the error instance.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation or recommended remediation steps for the error. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message describing the error.
status	string	Required within parent	A string indicating the status of the error.
subCategory	object	Optional	An object providing more specific details about the error category.

Referenced models: Batch assign members — response body — errors item errors item

Batch assign members — response body — errors item errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.
code	string	Optional	The status code associated with the error detail.
context	object	Optional	Context about the error condition, represented as an object with additional properties that are arrays of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
in	string	Optional	The name of the field or parameter in which the error was found.
message	string	Required within parent	A human readable message describing the error along with remediation steps where appropriate. This is a required field.
subCategory	string	Optional	A specific category that contains more specific detail about the error.

Policy, approvals and errors

SDK function policy ID: hubspot.teams_batch_add_team_members. Catalog operation: teams_batch_add_team_members. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["settings.users.teams.write"]

Official provider source