Update a data object

PATCH

/data-objects/:id

PATCH

/data-objects/:id

1 curl -X PATCH https:/https://api/data-objects/id \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "definition": {
3     "_id": "60f7c2b9e1d3f72b9c8e4a12",
4     "scope": "library",
5     "templateId": "tpl_9f8e7d6c5b4a3",
6     "projectId": "proj_123abc456def",
7     "nameSingular": "Task",
8     "namePlural": "Tasks",
9     "labelSingular": "Task",
10     "labelPlural": "Tasks",
11     "description": "A data object representing a task within a project management system.",
12     "icon": "check-circle",
13     "color": "#4A90E2",
14     "labelFieldKey": "title",
15     "fields": [
16       {}
17     ],
18     "fieldGroups": [
19       {}
20     ],
21     "version": 3,
22     "archivedAt": "2023-12-01T10:15:30Z",
23     "createdAt": "2023-01-15T08:00:00Z",
24     "updatedAt": "2024-04-20T12:45:00Z",
25     "createdBy": "user_789xyz",
26     "cardinality": {
27       "min": 1,
28       "max": 10
29     }
30   }
31 }

Applies a partial update to an object definition (field matching is by key; omitted fields are soft-archived). Authorization is scope-dependent: library/template need data-object:manage; project-scoped need the project’s project:object-manage.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

idstringRequired

Request

This endpoint expects an object.

labelSingularstringOptional1-200 characters

labelPluralstringOptional1-200 characters

namePluralstringOptional1-64 characters

descriptionstringOptional<=2000 characters

iconstringOptional1-64 characters

colorstring or nullOptional

labelFieldKeystringOptional>=1 character

fieldslist of objectsOptional

fieldGroupslist of objectsOptional

cardinalityobjectOptional

Response

The updated object definition.

definitionobject or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error