Batch

Create a batch of line items

Create multiple line items in a single request by providing the necessary properties and associations for each item. This endpoint allows for efficient batch processing of line items, returning the created objects with their unique identifiers.

post/crm/v3/objects/line_items/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 13 of the 55 revisions of this API.10231

    • endpoint added

      endpoint-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api path removed without deprecation

      api-path-removed-without-deprecation

    • 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

    • 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

    • the security scope crm.objects.line_items.write was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • 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

  • v3ab35e9ef0c80110See the full diff
    • the / response's property type changed from no type to object for status

      response-property-type-changed

    • the security scope crm.objects.line_items.write was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • 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

    • the security scope crm.objects.line_items.write was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

  • v30f669e3909af722See 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

    • the security scope crm.objects.line_items.write was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the security scope crm.objects.line_items.write was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • the security scope crm.objects.line_items.write was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed