> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.cloudraker.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server.

# Update a data object

PATCH /api/data-objects/{id}
Content-Type: application/json

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

Reference: https://docs.cloudraker.com/api/raker-one-api/data-objects/patch-data-objects-by-id

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: RakerOne API
  version: 1.0.0
paths:
  /data-objects/{id}:
    patch:
      operationId: patch-data-objects-by-id
      summary: Update a data object
      description: >-
        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`.
      tags:
        - subpackage_dataObjects
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            WorkOS session JWT or an organization API key, sent as
            `Authorization: Bearer <token>`.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The updated object definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataObjectResponse'
        '400':
          description: Bad request — the body or parameters failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized — missing or invalid bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden — the caller lacks the required permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            A blocking conflict (e.g. a field type change with existing
            records).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonObject'
        '422':
          description: The definition shape failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonObject'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                labelSingular:
                  type: string
                labelPlural:
                  type: string
                namePlural:
                  type: string
                description:
                  type: string
                icon:
                  type: string
                color:
                  type:
                    - string
                    - 'null'
                labelFieldKey:
                  type: string
                fields:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaFieldsItems
                fieldGroups:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaFieldGroupsItems
                cardinality:
                  $ref: >-
                    #/components/schemas/DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaCardinality
servers:
  - url: /api
    description: Current origin
  - url: https://app.raker.one/api
    description: Production
components:
  schemas:
    DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaFieldsItemsType:
      type: string
      enum:
        - text
        - long_text
        - number
        - currency
        - boolean
        - date
        - datetime
        - select
        - multi_select
        - email
        - phone
        - url
        - address
      title: DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaFieldsItemsType
    DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaFieldsItemsOptionsItemsColor:
      type: string
      enum:
        - gray
        - green
        - turquoise
        - sky
        - blue
        - purple
        - pink
        - red
        - orange
        - yellow
      title: >-
        DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaFieldsItemsOptionsItemsColor
    DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaFieldsItemsOptionsItems:
      type: object
      properties:
        value:
          type: string
        label:
          type: string
        color:
          $ref: >-
            #/components/schemas/DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaFieldsItemsOptionsItemsColor
        position:
          type: number
          format: double
      required:
        - value
        - label
        - color
        - position
      title: >-
        DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaFieldsItemsOptionsItems
    DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaFieldsItems:
      type: object
      properties:
        key:
          type: string
        label:
          type: string
        type:
          $ref: >-
            #/components/schemas/DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaFieldsItemsType
        description:
          type: string
          default: ''
        icon:
          type:
            - string
            - 'null'
        groupId:
          type:
            - string
            - 'null'
        position:
          type: number
          format: double
          default: 0
        required:
          type: boolean
          default: false
        unique:
          type: boolean
          default: false
        options:
          type: array
          items:
            $ref: >-
              #/components/schemas/DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaFieldsItemsOptionsItems
        settings:
          type: object
          additionalProperties:
            description: Any type
        defaultValue:
          description: Any type
        archived:
          type: boolean
          default: false
      required:
        - key
        - label
        - type
      title: DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaFieldsItems
    DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaFieldGroupsItems:
      type: object
      properties:
        id:
          type: string
        label:
          type: string
        position:
          type: number
          format: double
      required:
        - id
        - label
        - position
      title: >-
        DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaFieldGroupsItems
    DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaCardinality:
      type: object
      properties:
        min:
          type: integer
        max:
          type:
            - integer
            - 'null'
      required:
        - min
        - max
      title: DataObjectsIdPatchRequestBodyContentApplicationJsonSchemaCardinality
    DataObjectScope:
      type: string
      enum:
        - library
        - template
        - project
      title: DataObjectScope
    JsonObject:
      type: object
      additionalProperties:
        description: Any type
      description: An arbitrary JSON object.
      title: JsonObject
    DataObjectCardinality:
      type: object
      properties:
        min:
          type: number
          format: double
        max:
          type:
            - number
            - 'null'
          format: double
      required:
        - min
        - max
      title: DataObjectCardinality
    DataObject:
      type: object
      properties:
        _id:
          type: string
        scope:
          $ref: '#/components/schemas/DataObjectScope'
        templateId:
          type:
            - string
            - 'null'
        projectId:
          type:
            - string
            - 'null'
        nameSingular:
          type: string
        namePlural:
          type: string
        labelSingular:
          type: string
        labelPlural:
          type: string
        description:
          type: string
        icon:
          type: string
        color:
          type:
            - string
            - 'null'
        labelFieldKey:
          type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/JsonObject'
        fieldGroups:
          type: array
          items:
            $ref: '#/components/schemas/JsonObject'
        cardinality:
          $ref: '#/components/schemas/DataObjectCardinality'
        version:
          type: number
          format: double
        archivedAt:
          type:
            - string
            - 'null'
        createdAt:
          type: string
        updatedAt:
          type: string
        createdBy:
          type: string
      required:
        - _id
        - scope
        - templateId
        - projectId
        - nameSingular
        - namePlural
        - labelSingular
        - labelPlural
        - description
        - icon
        - color
        - labelFieldKey
        - fields
        - fieldGroups
        - version
        - archivedAt
        - createdAt
        - updatedAt
        - createdBy
      title: DataObject
    DataObjectResponse:
      type: object
      properties:
        definition:
          oneOf:
            - $ref: '#/components/schemas/DataObject'
            - type: 'null'
      required:
        - definition
      title: DataObjectResponse
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Machine-readable error code (e.g. `invalid_body`, `not_found`).
        issues:
          type: array
          items:
            description: Any type
          description: Schema-validation issues, present when `error` is `invalid_body`.
      required:
        - error
      description: Standard API error response.
      title: ErrorResponse
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        WorkOS session JWT or an organization API key, sent as `Authorization:
        Bearer <token>`.

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "definition": {
    "_id": "60f7c2b9e1d3f72b9c8e4a12",
    "scope": "library",
    "templateId": "tpl_9f8e7d6c5b4a3",
    "projectId": "proj_123abc456def",
    "nameSingular": "Task",
    "namePlural": "Tasks",
    "labelSingular": "Task",
    "labelPlural": "Tasks",
    "description": "A data object representing a task within a project management system.",
    "icon": "check-circle",
    "color": "#4A90E2",
    "labelFieldKey": "title",
    "fields": [
      {}
    ],
    "fieldGroups": [
      {}
    ],
    "version": 3,
    "archivedAt": "2023-12-01T10:15:30Z",
    "createdAt": "2023-01-15T08:00:00Z",
    "updatedAt": "2024-04-20T12:45:00Z",
    "createdBy": "user_789xyz",
    "cardinality": {
      "min": 1,
      "max": 10
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://api/data-objects/id"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api/data-objects/id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api/data-objects/id"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api/data-objects/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api/data-objects/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api/data-objects/id', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api/data-objects/id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api/data-objects/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```