Meta Pixel
RubikChat
RubikChat
Get Started Free

No credit card required · 14-day free trial

Schemas

A schema describes an object type: its id, names, properties and the object types it can be linked to. Read the schemas of the built-in objects, and create schemas for your own custom objects (for example vehicles, bookings or subscriptions).

Schema object

FieldDescription
idObject type id, used in URLs. Custom objects get an id that starts with 2-.
nameObject type name, also usable in URLs.
labels{ singular, plural } names shown in the dashboard.
primaryDisplayPropertyThe property shown as the title of a record.
requiredPropertiesProperties every record must have.
searchablePropertiesProperties used by search.
secondaryDisplayPropertiesProperties shown under the title.
associatedObjectsObject types this object can be linked to, with the association typeId.
propertiesThe properties of the object type.

List object types

Returns every object type available to your organization: the built-in ones (contacts, companies, deals…) and your custom objects. Each one lists its properties in short form.
GET/schemas
Example Request (cURL) · bash
curl --location --request GET 'https://api-proxy-v1.rubikchat.com/api/crm/v3/schemas' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'X-Organization-Slug: your-organization-slug' \
  --header 'Accept: application/json'

Status: 200 OK

Example Response · json
{
  "results": [
    {
      "id": "2-100001",
      "name": "vehicles",
      "fullyQualifiedName": "p7031_vehicles",
      "description": "Cars our customers own.",
      "labels": {
        "singular": "Vehicle",
        "plural": "Vehicles"
      },
      "primaryDisplayProperty": "plate_number",
      "requiredProperties": [
        "plate_number"
      ],
      "searchableProperties": [
        "plate_number",
        "model"
      ],
      "secondaryDisplayProperties": [
        "model"
      ],
      "associatedObjects": [
        {
          "id": "0-1",
          "typeId": 10021,
          "label": "0-1",
          "name": "contacts"
        }
      ],
      "archived": false,
      "properties": [
        {
          "name": "plate_number",
          "label": "Plate number",
          "type": "string",
          "fieldType": "text"
        },
        {
          "name": "model",
          "label": "Model",
          "type": "string",
          "fieldType": "text"
        }
      ],
      "propertiesCount": 2,
      "createdAt": "2026-11-12T10:00:00.000000Z",
      "updatedAt": "2026-11-12T10:00:00.000000Z",
      "isAllowed": true
    }
  ]
}

Create a custom object

Creates a custom object type with its properties.
POST/schemas

Request Body

NameTypeRequiredDescription
namestringrequiredObject name: lowercase letters, numbers and _, starting with a letter.
labelsobjectrequired{ singular, plural }.
propertiesarrayrequiredAt least one property: [{ name, label, type, fieldType, groupName?, hasUniqueValue?, options? }].
primaryDisplayPropertystringoptionalProperty shown as the title of a record.
requiredPropertiesarrayoptionalNames of required properties.
searchablePropertiesarrayoptionalNames of searchable properties.
secondaryDisplayPropertiesarrayoptionalNames of properties shown under the title.
associatedObjectsarrayoptionalObject type ids this object can be linked to, e.g. ["0-1"].
descriptionstringoptionalWhat the object is for.
Example Request (cURL) · bash
curl --location --request POST 'https://api-proxy-v1.rubikchat.com/api/crm/v3/schemas' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'X-Organization-Slug: your-organization-slug' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "vehicles",
  "description": "Cars our customers own.",
  "labels": {
    "singular": "Vehicle",
    "plural": "Vehicles"
  },
  "primaryDisplayProperty": "plate_number",
  "requiredProperties": [
    "plate_number"
  ],
  "searchableProperties": [
    "plate_number",
    "model"
  ],
  "secondaryDisplayProperties": [
    "model"
  ],
  "associatedObjects": [
    "0-1"
  ],
  "properties": [
    {
      "name": "plate_number",
      "label": "Plate number",
      "type": "string",
      "fieldType": "text",
      "hasUniqueValue": true
    },
    {
      "name": "model",
      "label": "Model",
      "type": "string",
      "fieldType": "text"
    }
  ]
}'

Status: 201 Created

Example Response · json
{
  "id": "2-100001",
  "name": "vehicles",
  "fullyQualifiedName": "p7031_vehicles",
  "description": "Cars our customers own.",
  "labels": {
    "singular": "Vehicle",
    "plural": "Vehicles"
  },
  "primaryDisplayProperty": "plate_number",
  "requiredProperties": [
    "plate_number"
  ],
  "searchableProperties": [
    "plate_number",
    "model"
  ],
  "secondaryDisplayProperties": [
    "model"
  ],
  "associatedObjects": [
    "0-1"
  ],
  "properties": [
    {
      "name": "plate_number",
      "label": "Plate number",
      "description": "",
      "type": "string",
      "fieldType": "text",
      "groupName": "other",
      "hasUniqueValue": true,
      "options": null,
      "displayOrder": 0,
      "calculated": false,
      "externalOptions": false,
      "formField": false
    },
    {
      "name": "model",
      "label": "Model",
      "description": "",
      "type": "string",
      "fieldType": "text",
      "groupName": "other",
      "hasUniqueValue": false,
      "options": null,
      "displayOrder": 1,
      "calculated": false,
      "externalOptions": false,
      "formField": false
    }
  ],
  "createdAt": "2026-11-12T10:00:00.000000Z",
  "updatedAt": "2026-11-12T10:00:00.000000Z"
}

Note

Keep the id of the reply: it is the object type you use in /objects/2-100001. The name works too. An object with the same name gives 409 Conflict.

Read an object type

Returns one object type with all its properties.
GET/schemas/{objectType}

Path Parameters

NameTypeRequiredDescription
objectTypestringrequiredObject type id (e.g. 2-100001) or name (e.g. vehicles).
Example Request (cURL) · bash
curl --location --request GET 'https://api-proxy-v1.rubikchat.com/api/crm/v3/schemas/2-100001' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'X-Organization-Slug: your-organization-slug' \
  --header 'Accept: application/json'

Status: 200 OK

Example Response · json
{
  "id": "2-100001",
  "name": "vehicles",
  "fullyQualifiedName": "p7031_vehicles",
  "description": "Cars our customers own.",
  "labels": {
    "singular": "Vehicle",
    "plural": "Vehicles"
  },
  "primaryDisplayProperty": "plate_number",
  "requiredProperties": [
    "plate_number"
  ],
  "searchableProperties": [
    "plate_number",
    "model"
  ],
  "secondaryDisplayProperties": [
    "model"
  ],
  "associatedObjects": [
    {
      "id": "0-1",
      "typeId": 10021,
      "label": "0-1",
      "name": "contacts"
    }
  ],
  "archived": false,
  "properties": [
    {
      "name": "plate_number",
      "label": "Plate number",
      "description": "",
      "type": "string",
      "fieldType": "text",
      "groupName": "other",
      "hasUniqueValue": true,
      "hidden": false,
      "displayOrder": 0,
      "calculated": false,
      "externalOptions": false,
      "archived": false,
      "formField": false,
      "options": null,
      "modificationMetadata": {
        "archivable": true,
        "readOnlyDefinition": false,
        "readOnlyValue": false
      }
    },
    {
      "name": "model",
      "label": "Model",
      "description": "",
      "type": "string",
      "fieldType": "text",
      "groupName": "other",
      "hasUniqueValue": false,
      "hidden": false,
      "displayOrder": 1,
      "calculated": false,
      "externalOptions": false,
      "archived": false,
      "formField": false,
      "options": null,
      "modificationMetadata": {
        "archivable": true,
        "readOnlyDefinition": false,
        "readOnlyValue": false
      }
    }
  ],
  "propertiesCount": 2,
  "createdAt": "2026-11-12T10:00:00.000000Z",
  "updatedAt": "2026-11-12T10:00:00.000000Z"
}

Update a custom object

Changes the description of a custom object.
PATCH/schemas/{objectType}

Path Parameters

NameTypeRequiredDescription
objectTypestringrequiredObject type id (e.g. 2-100001) or name (e.g. vehicles).

Request Body

NameTypeRequiredDescription
descriptionstringoptionalNew description.
Example Request (cURL) · bash
curl --location --request PATCH 'https://api-proxy-v1.rubikchat.com/api/crm/v3/schemas/2-100001' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'X-Organization-Slug: your-organization-slug' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "Cars and vans our customers own."
}'

Status: 200 OK

Example Response · json
{
  "id": "2-100001",
  "name": "vehicles",
  "fullyQualifiedName": "p7031_vehicles",
  "description": "Cars and vans our customers own.",
  "labels": {
    "singular": "Vehicle",
    "plural": "Vehicles"
  },
  "primaryDisplayProperty": "plate_number",
  "requiredProperties": [
    "plate_number"
  ],
  "searchableProperties": [
    "plate_number",
    "model"
  ],
  "secondaryDisplayProperties": [
    "model"
  ],
  "associatedObjects": [
    "0-1"
  ],
  "createdAt": "2026-11-12T10:00:00.000000Z",
  "updatedAt": "2026-11-12T11:30:00.000000Z"
}

The name and labels of an object type cannot be changed after it is created. Add or change its fields with the Properties endpoints.

Delete a custom object

Deletes a custom object type.
DELETE/schemas/{objectType}

Path Parameters

NameTypeRequiredDescription
objectTypestringrequiredObject type id (e.g. 2-100001) or name (e.g. vehicles).
Example Request (cURL) · bash
curl --location --request DELETE 'https://api-proxy-v1.rubikchat.com/api/crm/v3/schemas/2-100001' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'X-Organization-Slug: your-organization-slug' \
  --header 'Accept: application/json'

Status: 204 No Content

The reply has no body.

Warning

A custom object can only be deleted when it has no records and no association types. Otherwise the reply is 409 Conflict with the reason. Built-in objects cannot be deleted.