Sign in
Basic

Update

Perform a partial update of an Object identified by {lineItemId}or optionally a unique property value as specified by the idProperty query param. {lineItemId} refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.

patch/crm/v3/objects/line_items/{lineItemId}

Path parameters

lineItemIdstring required

Query parameters

idPropertystring

The name of a property whose values are unique for this object type

Request body

propertiesobject required

Key value pairs representing the properties of the object.

Example request

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

Response

successful operation

archivedboolean required

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.

idstring required

The unique ID of the object.

objectWriteTraceIdstring

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

propertiesobject required

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.

Example response

{
  "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.222

  • v38f97a0e8a2441See the full diff
    • ○

      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

  • v30ac07674715e1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

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

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

  • v3a3ce821b367e3See the full diff
    • ○

      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

  • v3ab35e9ef0c802See the full diff
    • ○

      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

  • v3a1ef8b0912922See the full diff
    • ○

      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

  • v30f669e3909af2See the full diff
    • ○

      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

  • v3ae062b0d7e2e2See the full diff
    • ○

      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

  • v3ab35e9ef0c802See the full diff
    • ○

      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