/crm/v3/objects/contacts/batch/create
application/json
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 |
successful operation
multiple statuses
POST /crm/v3/objects/contacts/batch/create
/crm/v3/objects/contacts/batch/read
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| archived | query | optional | boolean | Whether to return only results that have been archived. |
application/json
BatchReadInputSimplePublicObjectId
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| idProperty | string | optional |
| properties | array | required |
| propertiesWithHistory | array | required |
successful operation
multiple statuses
POST /crm/v3/objects/contacts/batch/read
/crm/v3/objects/contacts/batch/update
application/json
BatchInputSimplePublicObjectBatchInput
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| └ idProperty | string | optional |
| └ properties | object | required |
successful operation
multiple statuses
POST /crm/v3/objects/contacts/batch/update
/crm/v3/objects/deals/batch/archive
application/json
BatchInputSimplePublicObjectId
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
No content
POST /crm/v3/objects/deals/batch/archive
/crm/v3/objects/deals/batch/create
application/json
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 |
successful operation
multiple statuses
POST /crm/v3/objects/deals/batch/create
/crm/v3/objects/deals/batch/read
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| archived | query | optional | boolean | Whether to return only results that have been archived. |
application/json
BatchReadInputSimplePublicObjectId
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| idProperty | string | optional |
| properties | array | required |
| propertiesWithHistory | array | required |
successful operation
multiple statuses
POST /crm/v3/objects/deals/batch/read
/crm/v3/objects/deals/batch/update
application/json
BatchInputSimplePublicObjectBatchInput
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| └ idProperty | string | optional |
| └ properties | object | required |
successful operation
multiple statuses
POST /crm/v3/objects/deals/batch/update
/crm/v3/objects/feedback_submissions/batch/archive
application/json
BatchInputSimplePublicObjectId
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
No content
POST /crm/v3/objects/feedback_submissions/batch/archive
/crm/v3/objects/feedback_submissions/batch/create
application/json
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 |
successful operation
multiple statuses
POST /crm/v3/objects/feedback_submissions/batch/create
/crm/v3/objects/feedback_submissions/batch/read
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| archived | query | optional | boolean | Whether to return only results that have been archived. |
application/json
BatchReadInputSimplePublicObjectId
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| idProperty | string | optional |
| properties | array | required |
| propertiesWithHistory | array | required |
successful operation
multiple statuses
POST /crm/v3/objects/feedback_submissions/batch/read
/crm/v3/objects/feedback_submissions/batch/update
application/json
BatchInputSimplePublicObjectBatchInput
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| └ idProperty | string | optional |
| └ properties | object | required |
successful operation
multiple statuses
POST /crm/v3/objects/feedback_submissions/batch/update
/crm/v3/objects/line_items/batch/archive
application/json
BatchInputSimplePublicObjectId
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
No content
POST /crm/v3/objects/line_items/batch/archive
/crm/v3/objects/line_items/batch/create
application/json
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 |
successful operation
multiple statuses
POST /crm/v3/objects/line_items/batch/create
/crm/v3/objects/line_items/batch/read
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| archived | query | optional | boolean | Whether to return only results that have been archived. |
application/json
BatchReadInputSimplePublicObjectId
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| idProperty | string | optional |
| properties | array | required |
| propertiesWithHistory | array | required |
successful operation
multiple statuses
POST /crm/v3/objects/line_items/batch/read
/crm/v3/objects/line_items/batch/update
application/json
BatchInputSimplePublicObjectBatchInput
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| └ idProperty | string | optional |
| └ properties | object | required |
successful operation
multiple statuses
POST /crm/v3/objects/line_items/batch/update
/crm/v3/objects/products/batch/archive
application/json
BatchInputSimplePublicObjectId
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
No content
POST /crm/v3/objects/products/batch/archive
/crm/v3/objects/products/batch/create
application/json
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 |
successful operation
multiple statuses
POST /crm/v3/objects/products/batch/create
/crm/v3/objects/products/batch/read
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| archived | query | optional | boolean | Whether to return only results that have been archived. |
application/json
BatchReadInputSimplePublicObjectId
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| idProperty | string | optional |
| properties | array | required |
| propertiesWithHistory | array | required |
successful operation
multiple statuses
POST /crm/v3/objects/products/batch/read
/crm/v3/objects/products/batch/update
application/json
BatchInputSimplePublicObjectBatchInput
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| └ idProperty | string | optional |
| └ properties | object | required |
successful operation
multiple statuses
POST /crm/v3/objects/products/batch/update
/crm/v3/objects/quotes/batch/archive
application/json
BatchInputSimplePublicObjectId
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
No content
POST /crm/v3/objects/quotes/batch/archive
/crm/v3/objects/quotes/batch/create
application/json
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 |
successful operation
multiple statuses
POST /crm/v3/objects/quotes/batch/create
/crm/v3/objects/quotes/batch/read
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| archived | query | optional | boolean | Whether to return only results that have been archived. |
application/json
BatchReadInputSimplePublicObjectId
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| idProperty | string | optional |
| properties | array | required |
| propertiesWithHistory | array | required |
successful operation
multiple statuses
POST /crm/v3/objects/quotes/batch/read
/crm/v3/objects/quotes/batch/update
application/json
BatchInputSimplePublicObjectBatchInput
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| └ idProperty | string | optional |
| └ properties | object | required |
successful operation
multiple statuses
POST /crm/v3/objects/quotes/batch/update
/crm/v3/objects/tickets/batch/archive
application/json
BatchInputSimplePublicObjectId
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
No content
POST /crm/v3/objects/tickets/batch/archive
/crm/v3/objects/tickets/batch/create
application/json
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 |
successful operation
multiple statuses
POST /crm/v3/objects/tickets/batch/create
/crm/v3/objects/tickets/batch/read
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| archived | query | optional | boolean | Whether to return only results that have been archived. |
application/json
BatchReadInputSimplePublicObjectId
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| idProperty | string | optional |
| properties | array | required |
| propertiesWithHistory | array | required |
successful operation
multiple statuses
POST /crm/v3/objects/tickets/batch/read
/crm/v3/objects/tickets/batch/update
application/json
BatchInputSimplePublicObjectBatchInput
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| └ idProperty | string | optional |
| └ properties | object | required |
successful operation
multiple statuses
POST /crm/v3/objects/tickets/batch/update
/crm/v3/objects/{objectType}/batch/archive
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| objectType | path | required | string | — |
application/json
BatchInputSimplePublicObjectId
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
No content
POST /crm/v3/objects/{objectType}/batch/archive
/crm/v3/objects/{objectType}/batch/create
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| objectType | path | required | string | — |
application/json
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 |
successful operation
multiple statuses
POST /crm/v3/objects/{objectType}/batch/create
/crm/v3/objects/{objectType}/batch/read
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| objectType | path | required | string | — |
| archived | query | optional | boolean | Whether to return only results that have been archived. |
application/json
BatchReadInputSimplePublicObjectId
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| idProperty | string | optional |
| properties | array | required |
| propertiesWithHistory | array | required |
successful operation
multiple statuses
POST /crm/v3/objects/{objectType}/batch/read
/crm/v3/objects/{objectType}/batch/update
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| objectType | path | required | string | — |
application/json
BatchInputSimplePublicObjectBatchInput
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ id | string | required |
| └ idProperty | string | optional |
| └ properties | object | required |
successful operation
multiple statuses
POST /crm/v3/objects/{objectType}/batch/update
/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).
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| objectType | path | required | string | — |
application/json
BatchInputPropertyName
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ name | string | required |
No content
POST /crm/v3/properties/{objectType}/batch/archive
/crm/v3/properties/{objectType}/batch/create
Create a batch of properties using the same rules as when creating an individual property.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| objectType | path | required | string | — |
application/json
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 |
successful operation
multiple statuses
POST /crm/v3/properties/{objectType}/batch/create
/crm/v3/properties/{objectType}/batch/read
Read a provided list of properties.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| objectType | path | required | string | — |
application/json
BatchReadInputPropertyName
| Property | Type | Required |
|---|---|---|
| inputs | array | required |
| └ name | string | required |
| archived | boolean | required |
successful operation
multiple statuses
POST /crm/v3/properties/{objectType}/batch/read
/crm/v3/imports
Returns a paged list of active imports for this account.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| after | query | optional | string | The paging cursor token of the last successfully read resource will be returned as the |
| before | query | optional | string | — |
| limit | query | optional | integer | The maximum number of results to display per page. |
successful operation
GET /crm/v3/imports
/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.
multipart/form-data
CoreStartImportRequest
| Property | Type | Required |
|---|---|---|
| files | string | optional |
| importRequest | string | optional |
successful operation
POST /crm/v3/imports
/crm/v3/imports/{importId}
A complete summary of an import record, including any updates.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| importId | path | required | integer | — |
successful operation
GET /crm/v3/imports/{importId}
/crm/v3/imports/{importId}/cancel
This allows a developer to cancel an active import.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| importId | path | required | integer | — |
successful operation
POST /crm/v3/imports/{importId}/cancel
/crm/v3/properties/{objectType}
Read all existing properties for the specified object type and HubSpot account.
| 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 | — |
successful operation
GET /crm/v3/properties/{objectType}
/crm/v3/properties/{objectType}
Create and return a copy of a new property for the specified object type.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| objectType | path | required | string | — |
application/json
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 |
successful operation
POST /crm/v3/properties/{objectType}
/crm/v3/properties/{objectType}/{propertyName}
Move a property identified by {propertyName} to the recycling bin.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| objectType | path | required | string | — |
| propertyName | path | required | string | — |
No content
DELETE /crm/v3/properties/{objectType}/{propertyName}
/crm/v3/properties/{objectType}/{propertyName}
Read a property identified by {propertyName}.
| 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 | — |
successful operation
GET /crm/v3/properties/{objectType}/{propertyName}
/crm/v3/properties/{objectType}/{propertyName}
Perform a partial update of a property identified by {propertyName}. Provided fields will be overwritten.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| objectType | path | required | string | — |
| propertyName | path | required | string | — |
application/json
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 |
successful operation
PATCH /crm/v3/properties/{objectType}/{propertyName}
/crm/v3/schemas
Returns all object schemas that have been defined for your account.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| archived | query | optional | boolean | Whether to return only results that have been archived. |
successful operation
GET /crm/v3/schemas
/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.
Object schema definition, including properties and associations.
application/json
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 |
successful operation
POST /crm/v3/schemas
/crm/v3/schemas/{objectType}
Deletes a schema. Any existing records of this schema must be deleted first. Otherwise this call will fail.
| 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. |
No content
DELETE /crm/v3/schemas/{objectType}
/crm/v3/schemas/{objectType}
Returns an existing object schema.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| objectType | path | required | string | Fully qualified name or object type ID of your schema. |
successful operation
GET /crm/v3/schemas/{objectType}
/crm/v3/schemas/{objectType}
Update the details for an existing object schema.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| objectType | path | required | string | Fully qualified name or object type ID of your schema. |
Attributes to update in your schema.
application/json
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 |
successful operation
PATCH /crm/v3/schemas/{objectType}
/crm/v3/schemas/{objectType}/associations
Defines a new association between the primary schema’s object type and other object types.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| objectType | path | required | string | Fully qualified name or object type ID of your schema. |
Attributes that define the association.
application/json
AssociationDefinitionEgg
| Property | Type | Required |
|---|---|---|
| name | string | optional |
| toObjectTypeId | string | required |
| fromObjectTypeId | string | required |
successful operation
POST /crm/v3/schemas/{objectType}/associations
/crm/v3/schemas/{objectType}/associations/{associationIdentifier}
Removes an existing association from a schema.
| 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. |
No content
DELETE /crm/v3/schemas/{objectType}/associations/{associationIdentifier}