PATCH /v1/objects/{objectId}
Partially update an object with a JSON request body.
PATCH /v1/objects/{objectId} updates an existing object.
Authentication
Send an organization API key in x-api-key or
Authorization: Bearer <key>.
Path Parameters
| Name | Type | Description |
|---|---|---|
objectId | string (uuid) | UUID of the object to update. |
Request Body
Send a JSON object containing at least one of the following fields.
| Name | Type | Description |
|---|---|---|
name | string or null | Object name. Send null or an empty string to reset it to Untitled Object. |
description | array or null | Structured description content. |
designId | string (uuid) | Design to use for the object. |
statusId | string (uuid) or null | Object status. Send null to clear it. |
fields | object | Values for the object's custom fields. |
metadata | object | Additional object metadata. |
dataModelIds | array of strings (uuid) | Data models associated with the object. |
dataModelValues | object | Values grouped by data-model field. |
categoryIds | array of strings (uuid) | Categories assigned to the object. |
documentIds | array of strings (uuid) | Documents linked to the object. |
isPubliclyVisible | boolean | Whether the object is visible on the public website. |
Example
curl -X PATCH "https://api.blueputto.com/v1/objects/OBJECT_ID" \
-H "x-api-key: YOUR_API_KEY" \
-H "content-type: application/json" \
-d '{"name":"Restored chair"}'Success Response
200 OK
{
"data": {}
}Error Responses
400 Bad Request401 Unauthorized404 Not Found429 Too Many Requests