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

# Create a data-object definition

POST https://api.cloudraker.com/objects/definitions
Content-Type: application/json

Creates a new organization-level definition. Authorization: organization administrators only — other callers get 403. Body describes the schema: `nameSingular`/`namePlural`, labels, `fields[]` (13 field types, plus composites), `fieldGroups[]`, `labelFieldKey`, `icon`/`color`. Invalid schema returns 422 `validation_failed` (with `issues`). Returns 201 with `{ definition }`.

Reference: https://docs.cloudraker.com/workspace/api/data-objects/create-object-definition

## Authentication

- `Authorization` header (bearer token, required)

## Request

### Body (application/json)

- `nameSingular` (string, required)
- `labelSingular` (string, required)
- `labelPlural` (string, required)
- `namePlural` (string, required)
- `icon` (string, required)
- `labelFieldKey` (string, required)
- `fields` (list of map from string to any, required) — Field descriptors. Each names a `key`, a `type` and its type-specific options.
- `description` (string, optional) — Free-form description of the definition. Omitted means empty.
- `color` (string, optional, nullable)
- `fieldGroups` (list of map from string to any, optional)

## Response

### 201

The created definition.

- `definition` (object, required)
  - `_id` (string, required)
  - `nameSingular` (string, required)
  - `namePlural` (string, required)
  - `labelSingular` (string, required)
  - `labelPlural` (string, required)
  - `description` (string, required)
  - `icon` (string, required)
  - `color` (string, required, nullable)
  - `labelFieldKey` (string, required) — Field key whose value is the object’s display label.
  - `fields` (list of map from string to any, required) — The type-discriminated field model (13 field types plus composites). Emitted permissively so the resource stays navigable.
  - `fieldGroups` (list of map from string to any, required)
  - `version` (double, required) — Bumps only on a schema-affecting change.
  - `archivedAt` (datetime, required, nullable)
  - `createdAt` (datetime, required)
  - `updatedAt` (datetime, required)
  - `createdBy` (string, required)

## Examples

**Request**

```json
{
  "nameSingular": "contract",
  "labelSingular": "string",
  "labelPlural": "string",
  "namePlural": "string",
  "icon": "string",
  "labelFieldKey": "string",
  "fields": [
    {}
  ]
}
```

**Response**

```json
{
  "definition": {
    "_id": "def_contract",
    "nameSingular": "contract",
    "namePlural": "contracts",
    "labelSingular": "Contract",
    "labelPlural": "Contracts",
    "description": "string",
    "icon": "string",
    "color": "string",
    "labelFieldKey": "string",
    "fields": [
      {}
    ],
    "fieldGroups": [
      {}
    ],
    "version": 1.1,
    "archivedAt": "2024-01-15T09:30:00Z",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "createdBy": "string"
  }
}
```

**SDK Code**

```python
import requests

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

payload = {
    "nameSingular": "contract",
    "labelSingular": "string",
    "labelPlural": "string",
    "namePlural": "string",
    "icon": "string",
    "labelFieldKey": "string",
    "fields": [{}]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.cloudraker.com/objects/definitions';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"nameSingular":"contract","labelSingular":"string","labelPlural":"string","namePlural":"string","icon":"string","labelFieldKey":"string","fields":[{}]}'
};

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"

	payload := strings.NewReader("{\n  \"nameSingular\": \"contract\",\n  \"labelSingular\": \"string\",\n  \"labelPlural\": \"string\",\n  \"namePlural\": \"string\",\n  \"icon\": \"string\",\n  \"labelFieldKey\": \"string\",\n  \"fields\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("POST", 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")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"nameSingular\": \"contract\",\n  \"labelSingular\": \"string\",\n  \"labelPlural\": \"string\",\n  \"namePlural\": \"string\",\n  \"icon\": \"string\",\n  \"labelFieldKey\": \"string\",\n  \"fields\": [\n    {}\n  ]\n}"

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.post("https://api.cloudraker.com/objects/definitions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"nameSingular\": \"contract\",\n  \"labelSingular\": \"string\",\n  \"labelPlural\": \"string\",\n  \"namePlural\": \"string\",\n  \"icon\": \"string\",\n  \"labelFieldKey\": \"string\",\n  \"fields\": [\n    {}\n  ]\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.cloudraker.com/objects/definitions', [
  'body' => '{
  "nameSingular": "contract",
  "labelSingular": "string",
  "labelPlural": "string",
  "namePlural": "string",
  "icon": "string",
  "labelFieldKey": "string",
  "fields": [
    {}
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/objects/definitions");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"nameSingular\": \"contract\",\n  \"labelSingular\": \"string\",\n  \"labelPlural\": \"string\",\n  \"namePlural\": \"string\",\n  \"icon\": \"string\",\n  \"labelFieldKey\": \"string\",\n  \"fields\": [\n    {}\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "nameSingular": "contract",
  "labelSingular": "string",
  "labelPlural": "string",
  "namePlural": "string",
  "icon": "string",
  "labelFieldKey": "string",
  "fields": [[]]
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/objects/definitions")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```