Post /crm/v3/objects/{object Type}/batch/create Create

Create a batch of objects

POST/crm/v3/objects/{objectType}/batch/create

Use it in a workflow

Add a step and choose the HubSpot connector.
Pick the Post /crm/v3/objects/{object Type}/batch/create Create action (under Custom Objects).
Fill in the fields below, then reference the result from later steps as {{postCrmV3ObjectsObjectTypeBatchCreateCreate.response.data}}.

Request

Path parameters

objectTypestringrequired

Request body

Enter the body as JSON in the step's Body field.

inputsarray<object>required

associationsarray<object>required2 fields

objectWriteTraceIdstring

An identifier used for tracing the creation or update request of the object.

propertiesobjectrequired

Key value pairs representing the properties of the object.

json

{
  "inputs": [
    {
      "associations": [
        {
          "to": {
            "id": "string"
          },
          "types": [
            {
              "associationCategory": null,
              "associationTypeId": null
            }
          ]
        }
      ],
      "properties": {},
      "objectWriteTraceId": "string"
    }
  ]
}

Response

Returns 201 with an object. Read it in later steps with {{postCrmV3ObjectsObjectTypeBatchCreateCreate.response.data.<field>}}.

completedAtstring (date-time)

The timestamp when the batch processing was completed, in ISO 8601 format.

linksobject

An object containing relevant links related to the batch request.

requestedAtstring (date-time)

The timestamp when the batch request was initially made, in ISO 8601 format.

resultsarray<object>

archivedbooleanrequired

Whether the object is archived.

archivedAtstring (date-time)

The timestamp when the object was archived, in ISO 8601 format.

createdAtstring (date-time)required

The timestamp when the object was created, in ISO 8601 format.

idstringrequired

The unique ID of the object.

objectWriteTraceIdstring

An identifier used for tracing the write request for the object.

propertiesobjectrequired

Key-value pairs representing the properties of the object.

propertiesWithHistoryobject

Key-value pairs representing the properties of the object along with their history.

updatedAtstring (date-time)required

The timestamp when the object was last updated, in ISO 8601 format.

urlstring

The URL associated with the object.

warningsarray<object>3 fields

startedAtstring (date-time)

The timestamp when the batch processing began, in ISO 8601 format.

statusstring

The status of the batch processing request. The expected value is "COMPLETE".

One ofCANCELEDCOMPLETEPENDINGPROCESSING

json

{
  "completedAt": "2025-01-01T00:00:00Z",
  "results": [
    {
      "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"
    }
  ],
  "startedAt": "2025-01-01T00:00:00Z",
  "status": "CANCELED",
  "links": {},
  "requestedAt": "2025-01-01T00:00:00Z"
}

Need more? See the HubSpot guide for connection setup and behaviour shared by every action.

Was this page helpful?