HubSpot: Teams schemas

← Teams operations · All schemas

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 — 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

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.

Create Team — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
members	array	Required within parent	An array of team members to be assigned to the new team. Each member is represented by a TeamMemberAssignment object. This is a required field.
members[]	Model	Each item	Expand Add Team Members — request body — body
name	string	Required within parent	The name of the team to be created. This is a required field and must be a string.
parentTeamId	string	Optional	The unique identifier of the parent team, if the new team is a sub-team. This is an optional field and must be a string if provided.

Referenced models: Add Team Members — request body — body

Create Team — response body

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the team, represented as a string.
name	string	Required within parent	The name of the team, represented as a string.
parentTeamId	string	Optional	The unique identifier of the parent team, if applicable, represented as a string.

List members — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List teams — response body — paging
results	array	Required within parent	An array of team member responses, each represented by a TeamMemberResponse object.
results[]	Model	Each item	Expand Add Team Members — response body

Referenced models: Add Team Members — response body, List teams — response body — paging

List teams — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List teams — response body — paging
results	array	Required within parent	An array of team responses, each representing a team object.
results[]	Model	Each item	Expand Create Team — response body

Referenced models: Create Team — response body, List teams — response body — paging

List teams — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand List teams — response body — paging next

Referenced models: List teams — response body — paging next

List teams — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token representing the cursor position after the last successfully read resource. This is used to fetch the next set of results.
link	string	Optional	A string URL that provides the direct link to the next page of results.

Update team — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
name	object	Required within parent	An object representing the new name for the team.
parentTeamId	object	Required within parent	An object representing the ID of the parent team to which this team will be associated.