PATCH
/
crm
/
v3
/
objects
/
orders
/
{orderId}
Atualizar
curl --request PATCH \
  --url https://api.hubapi.com/crm/v3/objects/orders/{orderId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
  }
}'
{
  "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"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubGrátis

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • crm.objects.orders.write

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
orderId
string
required

Query Parameters

​
idProperty
string

O nome de uma propriedade cujos valores são exclusivos para este objeto

Body

application/json

Represents the input required to create or update a CRM object, containing an object with property names and their corresponding values.

​
properties
object
required

Key value pairs representing the properties of the object.

Example:

"{\"property_date\":\"1572480000000\",\"property_radio\":\"option_1\",\"property_number\":\"17\",\"property_string\":\"value\",\"property_checkbox\":\"false\",\"property_dropdown\":\"choice_b\",\"property_multiple_checkboxes\":\"chocolate;strawberry\"}"

Response

successful operation

A simple public object.

​
createdAt
string<date-time>
required

The timestamp when the object was created, in ISO 8601 format.

​
id
string
required

The unique ID of the object.

Example:

"512"

​
properties
object
required

Key-value pairs representing the properties of the object.

Example:

"{\"property_date\":\"1572480000000\",\"property_radio\":\"option_1\",\"property_number\":\"17\",\"property_string\":\"value\",\"property_checkbox\":\"false\",\"property_dropdown\":\"choice_b\",\"property_multiple_checkboxes\":\"chocolate;strawberry\"}"

​
updatedAt
string<date-time>
required

The timestamp when the object was last updated, in ISO 8601 format.

​
archived
boolean

Whether the object is archived.

​
archivedAt
string<date-time>

The timestamp when the object was archived, in ISO 8601 format.

​
propertiesWithHistory
object

Key-value pairs representing the properties of the object along with their history.

​
objectWriteTraceId
string