Batch 34 endpoints

POST /crm/v3/objects/contacts/batch/create
operationId: Batch_createContacts

Request Body

required
application/json
schema BatchInputSimplePublicObjectInputForCreate
Property Type Required
inputs array required
properties object required
associations array required
to object required
id string required
types array required
associationTypeId integer required
associationCategory string required

Responses

default
201

successful operation

207

multiple statuses

POST /crm/v3/objects/contacts/batch/create
POST /crm/v3/objects/contacts/batch/read
operationId: Batch_readContactsByProperties

Parameters

Name In Required Type Description
archived query optional boolean

Whether to return only results that have been archived.

Request Body

required
application/json
schema BatchReadInputSimplePublicObjectId
Property Type Required
inputs array required
id string required
idProperty string optional
properties array required
propertiesWithHistory array required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/contacts/batch/read
POST /crm/v3/objects/contacts/batch/update
operationId: Batch_updateContactsBatch

Request Body

required
application/json
schema BatchInputSimplePublicObjectBatchInput
Property Type Required
inputs array required
id string required
idProperty string optional
properties object required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/contacts/batch/update
POST /crm/v3/objects/deals/batch/archive
operationId: Batch_archiveDealsByIds

Request Body

required
application/json
schema BatchInputSimplePublicObjectId
Property Type Required
inputs array required
id string required

Responses

default
204

No content

POST /crm/v3/objects/deals/batch/archive
POST /crm/v3/objects/deals/batch/create
operationId: Batch_createDealsObject

Request Body

required
application/json
schema BatchInputSimplePublicObjectInputForCreate
Property Type Required
inputs array required
properties object required
associations array required
to object required
id string required
types array required
associationTypeId integer required
associationCategory string required

Responses

default
201

successful operation

207

multiple statuses

POST /crm/v3/objects/deals/batch/create
POST /crm/v3/objects/deals/batch/read
operationId: Batch_readDealsByInternalIdOrPropertyValues

Parameters

Name In Required Type Description
archived query optional boolean

Whether to return only results that have been archived.

Request Body

required
application/json
schema BatchReadInputSimplePublicObjectId
Property Type Required
inputs array required
id string required
idProperty string optional
properties array required
propertiesWithHistory array required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/deals/batch/read
POST /crm/v3/objects/deals/batch/update
operationId: Batch_updateDealsObjects

Request Body

required
application/json
schema BatchInputSimplePublicObjectBatchInput
Property Type Required
inputs array required
id string required
idProperty string optional
properties object required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/deals/batch/update
POST /crm/v3/objects/feedback_submissions/batch/archive
operationId: Batch_archiveFeedbackSubmissionsById

Request Body

required
application/json
schema BatchInputSimplePublicObjectId
Property Type Required
inputs array required
id string required

Responses

default
204

No content

POST /crm/v3/objects/feedback_submissions/batch/archive
POST /crm/v3/objects/feedback_submissions/batch/create
operationId: Batch_createFeedbackSubmissions

Request Body

required
application/json
schema BatchInputSimplePublicObjectInputForCreate
Property Type Required
inputs array required
properties object required
associations array required
to object required
id string required
types array required
associationTypeId integer required
associationCategory string required

Responses

default
201

successful operation

207

multiple statuses

POST /crm/v3/objects/feedback_submissions/batch/create
POST /crm/v3/objects/feedback_submissions/batch/read
operationId: Batch_readFeedbackSubmissions

Parameters

Name In Required Type Description
archived query optional boolean

Whether to return only results that have been archived.

Request Body

required
application/json
schema BatchReadInputSimplePublicObjectId
Property Type Required
inputs array required
id string required
idProperty string optional
properties array required
propertiesWithHistory array required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/feedback_submissions/batch/read
POST /crm/v3/objects/feedback_submissions/batch/update
operationId: Batch_updateFeedbackSubmissions

Request Body

required
application/json
schema BatchInputSimplePublicObjectBatchInput
Property Type Required
inputs array required
id string required
idProperty string optional
properties object required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/feedback_submissions/batch/update
POST /crm/v3/objects/line_items/batch/archive
operationId: Batch_archiveLineItemsByIds

Request Body

required
application/json
schema BatchInputSimplePublicObjectId
Property Type Required
inputs array required
id string required

Responses

default
204

No content

POST /crm/v3/objects/line_items/batch/archive
POST /crm/v3/objects/line_items/batch/create
operationId: Batch_lineItemsCreateBatch

Request Body

required
application/json
schema BatchInputSimplePublicObjectInputForCreate
Property Type Required
inputs array required
properties object required
associations array required
to object required
id string required
types array required
associationTypeId integer required
associationCategory string required

Responses

default
201

successful operation

207

multiple statuses

POST /crm/v3/objects/line_items/batch/create
POST /crm/v3/objects/line_items/batch/read
operationId: Batch_readLineItems

Parameters

Name In Required Type Description
archived query optional boolean

Whether to return only results that have been archived.

Request Body

required
application/json
schema BatchReadInputSimplePublicObjectId
Property Type Required
inputs array required
id string required
idProperty string optional
properties array required
propertiesWithHistory array required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/line_items/batch/read
POST /crm/v3/objects/line_items/batch/update
operationId: Batch_updateLineItems

Request Body

required
application/json
schema BatchInputSimplePublicObjectBatchInput
Property Type Required
inputs array required
id string required
idProperty string optional
properties object required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/line_items/batch/update
POST /crm/v3/objects/products/batch/archive
operationId: Batch_archiveProductsByIds

Request Body

required
application/json
schema BatchInputSimplePublicObjectId
Property Type Required
inputs array required
id string required

Responses

default
204

No content

POST /crm/v3/objects/products/batch/archive
POST /crm/v3/objects/products/batch/create
operationId: Batch_createProductsBatch

Request Body

required
application/json
schema BatchInputSimplePublicObjectInputForCreate
Property Type Required
inputs array required
properties object required
associations array required
to object required
id string required
types array required
associationTypeId integer required
associationCategory string required

Responses

default
201

successful operation

207

multiple statuses

POST /crm/v3/objects/products/batch/create
POST /crm/v3/objects/products/batch/read
operationId: Batch_readByProperties

Parameters

Name In Required Type Description
archived query optional boolean

Whether to return only results that have been archived.

Request Body

required
application/json
schema BatchReadInputSimplePublicObjectId
Property Type Required
inputs array required
id string required
idProperty string optional
properties array required
propertiesWithHistory array required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/products/batch/read
POST /crm/v3/objects/products/batch/update
operationId: Batch_updateProductsBatch

Request Body

required
application/json
schema BatchInputSimplePublicObjectBatchInput
Property Type Required
inputs array required
id string required
idProperty string optional
properties object required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/products/batch/update
POST /crm/v3/objects/quotes/batch/archive
operationId: Batch_archiveQuotesByIdBatch

Request Body

required
application/json
schema BatchInputSimplePublicObjectId
Property Type Required
inputs array required
id string required

Responses

default
204

No content

POST /crm/v3/objects/quotes/batch/archive
POST /crm/v3/objects/quotes/batch/create
operationId: Batch_createQuotesBatch

Request Body

required
application/json
schema BatchInputSimplePublicObjectInputForCreate
Property Type Required
inputs array required
properties object required
associations array required
to object required
id string required
types array required
associationTypeId integer required
associationCategory string required

Responses

default
201

successful operation

207

multiple statuses

POST /crm/v3/objects/quotes/batch/create
POST /crm/v3/objects/quotes/batch/read
operationId: Batch_readQuotesByPropertyValues

Parameters

Name In Required Type Description
archived query optional boolean

Whether to return only results that have been archived.

Request Body

required
application/json
schema BatchReadInputSimplePublicObjectId
Property Type Required
inputs array required
id string required
idProperty string optional
properties array required
propertiesWithHistory array required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/quotes/batch/read
POST /crm/v3/objects/quotes/batch/update
operationId: Batch_updateQuotesBatch

Request Body

required
application/json
schema BatchInputSimplePublicObjectBatchInput
Property Type Required
inputs array required
id string required
idProperty string optional
properties object required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/quotes/batch/update
POST /crm/v3/objects/tickets/batch/archive
operationId: Batch_archiveTicketsById

Request Body

required
application/json
schema BatchInputSimplePublicObjectId
Property Type Required
inputs array required
id string required

Responses

default
204

No content

POST /crm/v3/objects/tickets/batch/archive
POST /crm/v3/objects/tickets/batch/create
operationId: Batch_ticketCreationBatch

Request Body

required
application/json
schema BatchInputSimplePublicObjectInputForCreate
Property Type Required
inputs array required
properties object required
associations array required
to object required
id string required
types array required
associationTypeId integer required
associationCategory string required

Responses

default
201

successful operation

207

multiple statuses

POST /crm/v3/objects/tickets/batch/create
POST /crm/v3/objects/tickets/batch/read
operationId: Batch_readTicketsByProperties

Parameters

Name In Required Type Description
archived query optional boolean

Whether to return only results that have been archived.

Request Body

required
application/json
schema BatchReadInputSimplePublicObjectId
Property Type Required
inputs array required
id string required
idProperty string optional
properties array required
propertiesWithHistory array required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/tickets/batch/read
POST /crm/v3/objects/tickets/batch/update
operationId: Batch_updateTicketsBatch

Request Body

required
application/json
schema BatchInputSimplePublicObjectBatchInput
Property Type Required
inputs array required
id string required
idProperty string optional
properties object required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/tickets/batch/update
POST /crm/v3/objects/{objectType}/batch/archive
operationId: Batch_archiveObjectsById

Parameters

Name In Required Type Description
objectType path required string

Request Body

required
application/json
schema BatchInputSimplePublicObjectId
Property Type Required
inputs array required
id string required

Responses

default
204

No content

POST /crm/v3/objects/{objectType}/batch/archive
POST /crm/v3/objects/{objectType}/batch/create
operationId: Batch_createObjects

Parameters

Name In Required Type Description
objectType path required string

Request Body

required
application/json
schema BatchInputSimplePublicObjectInputForCreate
Property Type Required
inputs array required
properties object required
associations array required
to object required
id string required
types array required
associationTypeId integer required
associationCategory string required

Responses

default
201

successful operation

207

multiple statuses

POST /crm/v3/objects/{objectType}/batch/create
POST /crm/v3/objects/{objectType}/batch/read
operationId: Batch_readObjectsByInternalIdOrPropertyValues

Parameters

Name In Required Type Description
objectType path required string
archived query optional boolean

Whether to return only results that have been archived.

Request Body

required
application/json
schema BatchReadInputSimplePublicObjectId
Property Type Required
inputs array required
id string required
idProperty string optional
properties array required
propertiesWithHistory array required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/{objectType}/batch/read
POST /crm/v3/objects/{objectType}/batch/update
operationId: Batch_updateObjectsByInternalIdOrPropertyValues

Parameters

Name In Required Type Description
objectType path required string

Request Body

required
application/json
schema BatchInputSimplePublicObjectBatchInput
Property Type Required
inputs array required
id string required
idProperty string optional
properties object required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/objects/{objectType}/batch/update
POST /crm/v3/properties/{objectType}/batch/archive

Archive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent).

operationId: Batch_archiveProperties

Parameters

Name In Required Type Description
objectType path required string

Request Body

required
application/json
schema BatchInputPropertyName
Property Type Required
inputs array required
name string required

Responses

default
204

No content

POST /crm/v3/properties/{objectType}/batch/archive
POST /crm/v3/properties/{objectType}/batch/create

Create a batch of properties using the same rules as when creating an individual property.

operationId: Batch_propertiesCreateBatch

Parameters

Name In Required Type Description
objectType path required string

Request Body

required
application/json
schema BatchInputPropertyCreate
Property Type Required
inputs array required
name string required
type string required
label string required
hidden boolean optional
options array optional
label string required
value string required
hidden boolean required
description string optional
displayOrder integer required
fieldType string required
formField boolean optional
groupName string required
description string optional
displayOrder integer optional
hasUniqueValue boolean optional
externalOptions boolean optional
calculationFormula string optional
referencedObjectType string optional

Responses

default
201

successful operation

207

multiple statuses

POST /crm/v3/properties/{objectType}/batch/create
POST /crm/v3/properties/{objectType}/batch/read

Read a provided list of properties.

operationId: Batch_readProperties

Parameters

Name In Required Type Description
objectType path required string

Request Body

required
application/json
schema BatchReadInputPropertyName
Property Type Required
inputs array required
name string required
archived boolean required

Responses

default
200

successful operation

207

multiple statuses

POST /crm/v3/properties/{objectType}/batch/read

Core 16 endpoints

GET /crm/v3/imports

Returns a paged list of active imports for this account.

operationId: Core_getActiveImportsPage

Parameters

Name In Required Type Description
after query optional string

The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results.

before query optional string
limit query optional integer

The maximum number of results to display per page.

Responses

default
200

successful operation

GET /crm/v3/imports
POST /crm/v3/imports

Begins importing data from the specified file resources. This uploads the corresponding file and uses the import request object to convert rows in the files to objects.

operationId: Core_startImport

Request Body

multipart/form-data
schema CoreStartImportRequest
Property Type Required
files string optional
importRequest string optional

Responses

default
200

successful operation

POST /crm/v3/imports
GET /crm/v3/imports/{importId}

A complete summary of an import record, including any updates.

operationId: Core_getImportRecord

Parameters

Name In Required Type Description
importId path required integer

Responses

default
200

successful operation

GET /crm/v3/imports/{importId}
POST /crm/v3/imports/{importId}/cancel

This allows a developer to cancel an active import.

operationId: Core_cancelImport

Parameters

Name In Required Type Description
importId path required integer

Responses

default
200

successful operation

POST /crm/v3/imports/{importId}/cancel
GET /crm/v3/properties/{objectType}

Read all existing properties for the specified object type and HubSpot account.

operationId: Core_getAllProperties

Parameters

Name In Required Type Description
objectType path required string
archived query optional boolean

Whether to return only results that have been archived.

properties query optional string

Responses

default
200

successful operation

GET /crm/v3/properties/{objectType}
POST /crm/v3/properties/{objectType}

Create and return a copy of a new property for the specified object type.

operationId: Core_createProperty

Parameters

Name In Required Type Description
objectType path required string

Request Body

required
application/json
schema PropertyCreate
Property Type Required
name string required
type string required
label string required
hidden boolean optional
options array optional
label string required
value string required
hidden boolean required
description string optional
displayOrder integer required
fieldType string required
formField boolean optional
groupName string required
description string optional
displayOrder integer optional
hasUniqueValue boolean optional
externalOptions boolean optional
calculationFormula string optional
referencedObjectType string optional

Responses

default
201

successful operation

POST /crm/v3/properties/{objectType}
DELETE /crm/v3/properties/{objectType}/{propertyName}

Move a property identified by {propertyName} to the recycling bin.

operationId: Core_archiveProperty

Parameters

Name In Required Type Description
objectType path required string
propertyName path required string

Responses

default
204

No content

DELETE /crm/v3/properties/{objectType}/{propertyName}
GET /crm/v3/properties/{objectType}/{propertyName}

Read a property identified by {propertyName}.

operationId: Core_readProperty

Parameters

Name In Required Type Description
objectType path required string
propertyName path required string
archived query optional boolean

Whether to return only results that have been archived.

properties query optional string

Responses

default
200

successful operation

GET /crm/v3/properties/{objectType}/{propertyName}
PATCH /crm/v3/properties/{objectType}/{propertyName}

Perform a partial update of a property identified by {propertyName}. Provided fields will be overwritten.

operationId: Core_updatePropertyById

Parameters

Name In Required Type Description
objectType path required string
propertyName path required string

Request Body

required
application/json
schema PropertyUpdate
Property Type Required
type string optional
label string optional
hidden boolean optional
options array optional
label string required
value string required
hidden boolean required
description string optional
displayOrder integer required
fieldType string optional
formField boolean optional
groupName string optional
description string optional
displayOrder integer optional
calculationFormula string optional

Responses

default
200

successful operation

PATCH /crm/v3/properties/{objectType}/{propertyName}
GET /crm/v3/schemas

Returns all object schemas that have been defined for your account.

operationId: Core_getAllSchemas

Parameters

Name In Required Type Description
archived query optional boolean

Whether to return only results that have been archived.

Responses

default
200

successful operation

GET /crm/v3/schemas
POST /crm/v3/schemas

Define a new object schema, along with custom properties and associations. The entire object schema, including its object type ID, properties, and associations will be returned in the response.

operationId: Core_defineObjectSchema

Request Body

required

Object schema definition, including properties and associations.

application/json
schema ObjectSchemaEgg
Property Type Required
name string required
labels object required
plural string optional
singular string optional
properties array required
name string required
type string required
label string required
hidden boolean optional
options array optional
label string required
value string required
hidden boolean required
description string optional
displayOrder integer required
fieldType string required
formField boolean optional
groupName string optional
description string optional
displayOrder integer optional
hasUniqueValue boolean optional
textDisplayHint string optional
numberDisplayHint string optional
optionSortStrategy string optional
showCurrencySymbol boolean optional
referencedObjectType string optional
searchableInGlobalSearch boolean optional
description string optional
associatedObjects array required
requiredProperties array required
searchableProperties array optional
primaryDisplayProperty string optional
secondaryDisplayProperties array optional

Responses

default
201

successful operation

POST /crm/v3/schemas
DELETE /crm/v3/schemas/{objectType}

Deletes a schema. Any existing records of this schema must be deleted first. Otherwise this call will fail.

operationId: Core_deleteSchema

Parameters

Name In Required Type Description
objectType path required string

Fully qualified name or object type ID of your schema.

archived query optional boolean

Whether to return only results that have been archived.

Responses

default
204

No content

DELETE /crm/v3/schemas/{objectType}
GET /crm/v3/schemas/{objectType}

Returns an existing object schema.

operationId: Core_getExistingSchema

Parameters

Name In Required Type Description
objectType path required string

Fully qualified name or object type ID of your schema.

Responses

default
200

successful operation

GET /crm/v3/schemas/{objectType}
PATCH /crm/v3/schemas/{objectType}

Update the details for an existing object schema.

operationId: Core_updateSchemaObject

Parameters

Name In Required Type Description
objectType path required string

Fully qualified name or object type ID of your schema.

Request Body

required

Attributes to update in your schema.

application/json
schema ObjectTypeDefinitionPatch
Property Type Required
labels object optional
plural string optional
singular string optional
restorable boolean optional
description string optional
requiredProperties array optional
searchableProperties array optional
primaryDisplayProperty string optional
secondaryDisplayProperties array optional

Responses

default
200

successful operation

PATCH /crm/v3/schemas/{objectType}
POST /crm/v3/schemas/{objectType}/associations

Defines a new association between the primary schema’s object type and other object types.

operationId: Core_createAssociation

Parameters

Name In Required Type Description
objectType path required string

Fully qualified name or object type ID of your schema.

Request Body

required

Attributes that define the association.

application/json
schema AssociationDefinitionEgg
Property Type Required
name string optional
toObjectTypeId string required
fromObjectTypeId string required

Responses

default
201

successful operation

POST /crm/v3/schemas/{objectType}/associations
DELETE /crm/v3/schemas/{objectType}/associations/{associationIdentifier}

Removes an existing association from a schema.

operationId: Core_removeAssociation

Parameters

Name In Required Type Description
objectType path required string

Fully qualified name or object type ID of your schema.

associationIdentifier path required string

Unique ID of the association to remove.

Responses

default
204

No content

DELETE /crm/v3/schemas/{objectType}/associations/{associationIdentifier}
Load more endpoints