> ## Documentation Index
> Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Create a batch of tasks
> Create multiple tasks in a single request by providing a batch of task properties and associations. This endpoint allows for efficient task creation by processing multiple tasks together.
export const ScopesList = ({scopes = [], description = "Esta API requer um dos seguintes escopos:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
;
};
## OpenAPI
````yaml specs/legacy/v3/crm-tasks-v3.json POST /crm/v3/objects/tasks/batch/create
openapi: 3.0.1
info:
title: Tasks
description: >-
CRM objects such as companies, contacts, deals, line items, products,
tickets, and quotes are standard objects in HubSpot’s CRM. These core
building blocks support custom properties, store critical information, and
play a central role in the HubSpot application.
## Supported Object Types
This API provides access to collections of CRM objects, which return a map
of property names to values. Each object type has its own set of default
properties, which can be found by exploring the [CRM Object Properties
API](https://developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview).
|Object Type |Properties returned by default |
|--|--|
| `companies` | `name`, `domain` |
| `contacts` | `firstname`, `lastname`, `email` |
| `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` |
| `products` | `name`, `description`, `price` |
| `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`,
`hs_ticket_category`, `hs_ticket_priority`, `subject` |
Find a list of all properties for an object type using the [CRM Object
Properties](https://developers.hubspot.com/docs/methods/crm-properties/get-properties)
API. e.g. `GET https://api.hubapi.com/properties/v2/companies/properties`.
Change the properties returned in the response using the `properties` array
in the request body.
version: v3
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
x-hubspot-api-use-case: >-
If you're using a third-party service for project management, you can create
and manage any tasks associated with your CRM records by logging them in
HubSpot.
x-hubspot-related-documentation:
- name: Tasks Guide
url: https://developers.hubspot.com/docs/guides/api/crm/engagements/tasks
x-hubspot-introduction: >-
Use the tasks API to associate tasks with your CRM records. You can assign
tasks to specific users in your account, keep track of their status, and
organize them using different priorities and types.
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Basic
- name: Batch
- name: Search
paths:
/crm/v3/objects/tasks/batch/create:
post:
tags:
- Batch
summary: Create a batch of tasks
description: >-
Create multiple tasks in a single request by providing a batch of task
properties and associations. This endpoint allows for efficient task
creation by processing multiple tasks together.
operationId: post-/crm/v3/objects/tasks/batch/create_create
parameters: []
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/BatchInputSimplePublicObjectBatchInputForCreate
required: true
responses:
'201':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/BatchResponseSimplePublicObject'
'207':
description: multiple statuses
content:
application/json:
schema:
$ref: '#/components/schemas/BatchResponseSimplePublicObjectWithErrors'
default:
$ref: '#/components/responses/Error'
description: ''
security: []
components:
schemas:
BatchInputSimplePublicObjectBatchInputForCreate:
required:
- inputs
type: object
properties:
inputs:
type: array
description: >-
An array of simple public objects to be created. Each object in the
array contains the necessary data for creating a new entry in the
system.
items:
$ref: '#/components/schemas/SimplePublicObjectBatchInputForCreate'
description: >-
Represents a batch input for creating multiple simple public objects in
a single request. This component is used to streamline the process of
adding new objects to a HubSpot account by allowing multiple entries to
be created at once.
BatchResponseSimplePublicObject:
required:
- completedAt
- results
- startedAt
- status
type: object
properties:
completedAt:
type: string
description: >-
The timestamp when the batch processing was completed, in ISO 8601
format.
format: date-time
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs, providing additional
information or actions related to the batch operation.
requestedAt:
type: string
description: >-
The timestamp when the batch request was initially made, in ISO 8601
format.
format: date-time
results:
type: array
description: >-
An array of SimplePublicObject items representing the results of the
batch operation.
items:
$ref: '#/components/schemas/SimplePublicObject'
startedAt:
type: string
description: The timestamp when the batch processing began, in ISO 8601 format.
format: date-time
status:
type: string
description: >-
The status of the batch processing request: "PENDING", "PROCESSING",
"CANCELLED", or "COMPLETE"
enum:
- CANCELED
- COMPLETE
- PENDING
- PROCESSING
description: A public object batch response object
BatchResponseSimplePublicObjectWithErrors:
required:
- completedAt
- results
- startedAt
- status
type: object
properties:
completedAt:
type: string
description: >-
The timestamp when the batch process was completed, in ISO 8601
format.
format: date-time
errors:
type: array
items:
$ref: '#/components/schemas/StandardError'
links:
type: object
additionalProperties:
type: string
description: An object containing relevant links related to the batch request.
numErrors:
type: integer
description: The number of errors encountered during the batch process.
format: int32
requestedAt:
type: string
description: >-
The timestamp when the batch process was initiated, in ISO 8601
format.
format: date-time
results:
type: array
items:
$ref: '#/components/schemas/SimplePublicObject'
startedAt:
type: string
description: >-
The timestamp when the batch process began execution, in ISO 8601
format.
format: date-time
status:
type: string
description: >-
The status of the batch processing request - "PENDING",
"PROCESSING", "CANCELLED", or "COMPLETE"
enum:
- CANCELED
- COMPLETE
- PENDING
- PROCESSING
description: >-
Represents the result of a batch operation on CRM objects, including the
processing status, batch results, timestamps, and a list of any errors
encountered during the operation.
SimplePublicObjectBatchInputForCreate:
required:
- associations
- properties
type: object
properties:
associations:
type: array
description: >-
An array of associations that define the relationships between the
objects being created and other existing objects. This property is
required.
items:
$ref: '#/components/schemas/PublicAssociationsForObject'
objectWriteTraceId:
type: string
description: >-
An identifier used for tracing the creation or update request of the
object.
properties:
type: object
additionalProperties:
type: string
description: Key value pairs representing the properties of the object.
description: >-
An input object that contains a collection of objects to be created
together in a batch.
SimplePublicObject:
required:
- archived
- createdAt
- id
- properties
- updatedAt
type: object
properties:
archived:
type: boolean
description: Whether the object is archived.
archivedAt:
type: string
description: The timestamp when the object was archived, in ISO 8601 format.
format: date-time
createdAt:
type: string
description: The timestamp when the object was created, in ISO 8601 format.
format: date-time
id:
type: string
description: The unique ID of the object.
objectWriteTraceId:
type: string
description: >-
An identifier used to trace the write request for the object. Set a
unique ID for each write operation; it is returned with any errors
so you can identify which request encountered which error.
properties:
type: object
additionalProperties:
type: string
description: Key-value pairs representing the properties of the object.
propertiesWithHistory:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/ValueWithTimestamp'
description: >-
Key-value pairs representing the properties of the object along with
their history, each with a timestamp and source information.
updatedAt:
type: string
description: The timestamp when the object was last updated, in ISO 8601 format.
format: date-time
url:
type: string
description: The URL associated with the object.
warnings:
type: array
items:
$ref: '#/components/schemas/PublicObjectWarning'
description: A simple public object.
example:
archived: false
createdAt: '2019-10-30T03:30:17.883Z'
id: '512'
properties:
property_checkbox: 'false'
property_date: '1572480000000'
property_dropdown: choice_b
property_multiple_checkboxes: chocolate;strawberry
property_number: '17'
property_radio: option_1
property_string: value
updatedAt: '2019-12-07T16:50:06.678Z'
StandardError:
required:
- category
- context
- errors
- links
- message
- status
type: object
properties:
category:
type: string
description: The main category of the error.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Additional context-specific information related to the error.
errors:
type: array
description: The detailed error objects.
items:
$ref: '#/components/schemas/ErrorDetail'
id:
type: string
description: A unique ID for the error instance.
links:
type: object
additionalProperties:
type: string
description: >-
URLs linking to documentation or resources associated with the
error.
message:
type: string
description: >-
A human-readable string describing the error and possible
remediation steps.
status:
type: string
description: A text status code for the error, typically "error".
subCategory:
type: object
properties: {}
description: A more specific error category within each main category.
description: >-
Represents a standard error response in the HubSpot API, providing
detailed information about an error that occurred during an API request.
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request. Include this value with any
error reports or support tickets
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: further information about the error
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents an error response returned by the API when an operation
fails. This component is used in various endpoints to provide detailed
information about the error encountered.
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
PublicAssociationsForObject:
required:
- to
- types
type: object
properties:
to:
$ref: '#/components/schemas/PublicObjectId'
types:
type: array
description: >-
The types of associations that exist between the object and other
entities, indicating the nature of their relationship.
items:
$ref: '#/components/schemas/AssociationSpec'
description: >-
Represents the associations for a specific object in HubSpot, detailing
the types of associations and the related objects involved.
ValueWithTimestamp:
required:
- sourceType
- timestamp
- value
type: object
properties:
sourceId:
type: string
description: A string identifier for the specific source of the value.
sourceLabel:
type: string
description: A human-readable label.
sourceType:
type: string
description: >-
A string indicating the type of source from which the value
originated.
timestamp:
type: string
description: The timestamp when the property was updated, in ISO 8601 format.
format: date-time
updatedByUserId:
type: integer
description: The ID of the user who last updated the property.
format: int32
value:
type: string
description: The property value.
description: Property model that includes timestamp.
PublicObjectWarning:
required:
- category
- context
- message
type: object
properties:
category:
type: string
description: >-
The classification of the warning, indicating the type or nature of
the issue.
context:
type: object
additionalProperties:
type: string
description: >-
Additional information or metadata about the warning, providing
context for understanding the issue.
message:
type: string
description: >-
The text of the warning message, providing information about the
issue or alert.
description: >-
Represents a warning message related to a public object in HubSpot,
providing details about the nature and context of the warning.
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: The status code associated with the error detail
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: The name of the field or parameter in which the error was found.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
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.
PublicObjectId:
required:
- id
type: object
properties:
id:
type: string
description: The unique ID of the object.
description: Contains the Id of a Public Object
AssociationSpec:
required:
- associationCategory
- associationTypeId
type: object
properties:
associationCategory:
type: string
description: >-
The category of the association, indicating its origin or purpose.
Valid values include "HUBSPOT_DEFINED", "USER_DEFINED",
"INTEGRATOR_DEFINED", and "WORK".
enum:
- HUBSPOT_DEFINED
- INTEGRATOR_DEFINED
- USER_DEFINED
- WORK
associationTypeId:
type: integer
description: >-
An integer representing the unique identifier for the type of
association.
format: int32
description: >-
Defines the type, direction, and details of the relationship between two
CRM objects.
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
````
{product.name} -
{product.level}
)}