v1

latestOpenAPI 3.0.12026-07-13103041.6 KB

Basic

Update

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

patch/crm/v3/objects/bucket_test111s/{bucketTest111Id}

Path parameters

bucketTest111Idstring required

Query parameters

idPropertystring

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

Request body

propertiesobject required

Example request

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

Response

successful operation

createdAtstring date-time required

archivedboolean

archivedAtstring date-time

propertiesWithHistoryobject

idstring required

propertiesobject required

updatedAtstring date-time required

Example response

{
  "id": "512",
  "properties": {
    "property_string": "value",
    "property_number": "17",
    "property_date": "1572480000000",
    "property_radio": "option_1",
    "property_dropdown": "choice_b",
    "property_checkbox": "false",
    "property_multiple_checkboxes": "chocolate;strawberry"
  },
  "createdAt": "2019-10-30T03:30:17.883Z",
  "updatedAt": "2019-12-07T16:50:06.678Z",
  "archived": false
}