Batch

Update a batch of quotes by internal ID, or unique property values

Update multiple quotes using their internal IDs or unique property values. This endpoint allows batch processing of quote updates, ensuring efficient management of multiple records in a single request.

post/crm/v3/objects/quotes/batch/update

Request body

Example request

{
  "inputs": [
    {
      "idProperty": "my_unique_property_name"
    }
  ]
}

Response

successful operation

completedAtstring date-time required

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

linksobject

A map of link names to associated URIs, providing additional information or actions related to the batch operation.

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 16 of the 59 revisions of this API.9240

    • ○

      the endpoint scheme security oauth2 was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security oauth2 was removed from the API

      api-security-removed

    • ○

      the security scope crm.objects.quotes.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.quotes.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.quotes.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

    • ○

      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.quotes.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.quotes.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

  • v3a0dbba00d7b5110See 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.quotes.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.quotes.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