Batch

Create a batch of communications

Create a batch of messages. The inputs array can contain a properties object to define property values for each message, along with an associations array to define associations with other CRM records.

post/crm/v3/objects/communications/batch/create

Request body

Response

successful operation

completedAtstring date-time required

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.

startedAtstring date-time required

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

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE"

Example response

{
  "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"
    }
  ]
}

Changes

Changed in 9 of the 55 revisions of this API.10218

Sep 2, 2026v3a7c9a1222f8b1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 13, 2026v36a1666da27ea1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 13, 2026v32531fcdcdc191See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 13, 2026v369b41e2497e31See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
Jun 23, 2026v32531fcdcdc192See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Jun 15, 2026v305374d334cfc18See the full diff
- ▲
  the / response's property type changed from no type to object for status
  response-property-type-changed
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 15, 2026v3f24577fd501d72See the full diff
- ▲
  the / response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 15, 2026v3aa87273c3f595See the full diff
- ○
  the endpoint scheme security app_cookie was removed from the API
  api-security-removed
- ○
  the endpoint scheme security hapikey was removed from the API
  api-security-removed
- ○
  the endpoint scheme security internal_cookie was removed from the API
  api-security-removed
- ○
  the endpoint scheme security private_apps was removed from the API
  api-security-removed
- ○
  the endpoint scheme security shhkey was removed from the API
  api-security-removed
Apr 13, 2026v3bc2405b1d51f1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history