HUhubspot
Basic

Update

Changed on

Perform a partial update of an Object identified by {orderId}or optionally a unique property value as specified by the idProperty query param. {orderId} 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/objects/2026-03/orders/{orderId}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/objects/2026-03/orders/{orderId}
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

Path parameters

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

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.

Changes

Some revisions have not been checked yet.