> 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 definition

PATCH https://api.cloudraker.com/objects/definitions/{definitionId}
Content-Type: application/json

Applies a field-by-key diff to a definition. Authorization: organization administrators only — other callers get 403. Body is strict (immutable `name`/field keys rejected). Fields present are upserted; **omitting an active field soft-archives it** (archive-on-omit). Changing a field type while live objects exist returns 409 `type_change_blocked` (with `fieldKey`); the `version` bumps only on a schema-affecting change. Unknown id → 404, invalid body → 422 `validation_failed`. Returns `{ definition }`.

Reference: https://docs.cloudraker.com/api/cloud-raker-api/workspace/data-objects/update-object-definition

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: CloudRaker API
  version: 1.0.0
paths:
  /objects/definitions/{definitionId}:
    patch:
      operationId: update-object-definition
      summary: Update a data-object definition
      description: >-
        Applies a field-by-key diff to a definition. Authorization: organization
        administrators only — other callers get 403. Body is strict (immutable
        `name`/field keys rejected). Fields present are upserted; **omitting an
        active field soft-archives it** (archive-on-omit). Changing a field type
        while live objects exist returns 409 `type_change_blocked` (with
        `fieldKey`); the `version` bumps only on a schema-affecting change.
        Unknown id → 404, invalid body → 422 `validation_failed`. Returns `{
        definition }`.
      tags:
        - dataObjects
      parameters:
        - name: definitionId
          in: path
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: Bearer authentication
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The updated definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectDefinitionEnvelope'
        '403':
          description: Caller is not an org admin.
          content:
            application/json:
              schema:
                description: Any type
        '404':
          description: No definition with that id.
          content:
            application/json:
              schema:
                description: Any type
        '409':
          description: >-
            `type_change_blocked` — a field type change is blocked by live
            objects.
          content:
            application/json:
              schema:
                description: Any type
        '422':
          description: '`validation_failed` — the patch body is invalid.'
          content:
            application/json:
              schema:
                description: Any type
      requestBody:
        description: >-
          Strict: `nameSingular` and unknown keys are rejected. Fields present
          are upserted; omitting an active field soft-archives it.
        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:
                    type: object
                    additionalProperties:
                      description: Any type
                  description: >-
                    Field descriptors. Each names a `key`, a `type` and its
                    type-specific options.
                fieldGroups:
                  type: array
                  items:
                    type: object
                    additionalProperties:
                      description: Any type
servers:
  - url: https://api.cloudraker.com
    description: Production
  - url: https://api.staging.raker.one
    description: Staging
  - url: https://api.dev.raker.one
    description: Development
components:
  schemas:
    ObjectDefinition:
      type: object
      properties:
        _id:
          type: string
        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
          description: Field key whose value is the object’s display label.
        fields:
          type: array
          items:
            type: object
            additionalProperties:
              description: Any type
          description: >-
            The type-discriminated field model (13 field types plus composites).
            Emitted permissively so the resource stays navigable.
        fieldGroups:
          type: array
          items:
            type: object
            additionalProperties:
              description: Any type
        version:
          type: number
          format: double
          description: Bumps only on a schema-affecting change.
        archivedAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        createdBy:
          type: string
      required:
        - _id
        - nameSingular
        - namePlural
        - labelSingular
        - labelPlural
        - description
        - icon
        - color
        - labelFieldKey
        - fields
        - fieldGroups
        - version
        - archivedAt
        - createdAt
        - updatedAt
        - createdBy
      title: ObjectDefinition
    ObjectDefinitionEnvelope:
      type: object
      properties:
        definition:
          $ref: '#/components/schemas/ObjectDefinition'
      required:
        - definition
      title: ObjectDefinitionEnvelope
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "definition": {
    "_id": "def_contract",
    "nameSingular": "contract",
    "namePlural": "contracts",
    "labelSingular": "Contract",
    "labelPlural": "Contracts",
    "description": "A legal agreement between two or more parties outlining terms and conditions.",
    "icon": "file-contract",
    "color": "#4A90E2",
    "labelFieldKey": "title",
    "fields": [
      {}
    ],
    "fieldGroups": [
      {}
    ],
    "version": 1.1,
    "archivedAt": "2024-01-15T09:30:00Z",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "createdBy": "admin_user_123"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.cloudraker.com/objects/definitions/definitionId"

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.cloudraker.com/objects/definitions/definitionId';
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.cloudraker.com/objects/definitions/definitionId"

	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.cloudraker.com/objects/definitions/definitionId")

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.cloudraker.com/objects/definitions/definitionId")
  .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.cloudraker.com/objects/definitions/definitionId', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/objects/definitions/definitionId");
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.cloudraker.com/objects/definitions/definitionId")! 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()
```