Properties
Properties are the fields of an object type, such as email on contacts or amount on deals. Read them to know which values a record can have, and create your own properties for the data you need.
Property object
| Field | Description |
|---|---|
| name | Internal name, used as the key in a record’s properties. Lowercase letters, numbers and _ , starting with a letter. |
| label | Name shown in the dashboard. |
| type | string, number, boolean, date, dateTime or enumeration. |
| fieldType | How the field is edited: text, textarea, number, select, radio, checkbox, date, boolean, phone, calculation_equation, html or file. |
| groupName | The group the property is shown in. |
| options | For enumeration properties: [{ label, value, displayOrder, hidden }]. |
| hasUniqueValue | Whether each record must have a different value. |
| modificationMetadata | archivable is false for built-in properties, which cannot be deleted. |
List properties
Returns every property of an object type that is not archived.
GET/properties/{objectType}
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| objectType | string | required | Object type id (0-1 contacts, 0-2 companies, 0-3 deals, 2-… custom objects) or its name, e.g. contacts. |
Example Request (cURL) · bash
curl --location --request GET 'https://api-proxy-v1.rubikchat.com/api/crm/v3/properties/contacts' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'X-Organization-Slug: your-organization-slug' \
--header 'Accept: application/json'Status: 200 OK
Example Response · json
{
"results": [
{
"name": "email",
"label": "Email",
"description": "",
"groupName": "contactinformation",
"type": "string",
"fieldType": "text",
"options": [],
"displayOrder": 3,
"calculated": false,
"calculationFormula": null,
"externalOptions": false,
"hasUniqueValue": false,
"hidden": false,
"formField": false,
"archived": false,
"createdAt": "2026-11-12T10:00:00+00:00",
"updatedAt": "2026-11-12T10:00:00+00:00",
"modificationMetadata": {
"archivable": false,
"readOnlyDefinition": true,
"readOnlyValue": true
}
},
{
"name": "favorite_color",
"label": "Favorite color",
"description": "The color the contact likes most.",
"groupName": "contactinformation",
"type": "enumeration",
"fieldType": "select",
"options": [
{
"label": "Red",
"value": "red",
"displayOrder": 0,
"hidden": false
},
{
"label": "Blue",
"value": "blue",
"displayOrder": 1,
"hidden": false
}
],
"displayOrder": 12,
"calculated": false,
"calculationFormula": null,
"externalOptions": false,
"hasUniqueValue": false,
"hidden": false,
"formField": true,
"archived": false,
"createdAt": "2026-11-12T10:00:00+00:00",
"updatedAt": "2026-11-12T10:00:00+00:00",
"modificationMetadata": {
"archivable": true,
"readOnlyDefinition": false,
"readOnlyValue": false
}
}
]
}Read a property
Returns one property by its name.
GET/properties/{objectType}/{propertyName}
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| objectType | string | required | Object type id (0-1 contacts, 0-2 companies, 0-3 deals, 2-… custom objects) or its name, e.g. contacts. |
| propertyName | string | required | The internal name of the property, e.g. favorite_color. |
Example Request (cURL) · bash
curl --location --request GET 'https://api-proxy-v1.rubikchat.com/api/crm/v3/properties/contacts/favorite_color' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'X-Organization-Slug: your-organization-slug' \
--header 'Accept: application/json'Status: 200 OK
Example Response · json
{
"name": "favorite_color",
"label": "Favorite color",
"description": "The color the contact likes most.",
"groupName": "contactinformation",
"type": "enumeration",
"fieldType": "select",
"options": [
{
"label": "Red",
"value": "red",
"displayOrder": 0,
"hidden": false
},
{
"label": "Blue",
"value": "blue",
"displayOrder": 1,
"hidden": false
}
],
"displayOrder": 12,
"calculated": false,
"calculationFormula": null,
"externalOptions": false,
"hasUniqueValue": false,
"hidden": false,
"formField": true,
"archived": false,
"createdAt": "2026-11-12T10:00:00+00:00",
"updatedAt": "2026-11-12T10:00:00+00:00",
"modificationMetadata": {
"archivable": true,
"readOnlyDefinition": false,
"readOnlyValue": false
}
}Create a property
Adds a property to an object type.
POST/properties/{objectType}
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| objectType | string | required | Object type id (0-1 contacts, 0-2 companies, 0-3 deals, 2-… custom objects) or its name, e.g. contacts. |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | required | Internal name: lowercase letters, numbers and _, starting with a letter. |
| label | string | required | Name shown in the dashboard. |
| type | string | required | string, number, boolean, date, dateTime or enumeration. |
| fieldType | string | required | text, textarea, number, select, radio, checkbox, date, boolean, phone, calculation_equation, html or file. |
| groupName | string | required | The group to show the property in. See Property groups. |
| description | string | optional | Help text, up to 1000 characters. |
| options | array | optional | For enumeration properties: [{ label, value, displayOrder?, hidden? }]. |
| hasUniqueValue | boolean | optional | Each record must have a different value. Up to 10 per object type. |
| hidden | boolean | optional | Hide the property in the dashboard. |
| formField | boolean | optional | Allow the property in forms. |
| calculationFormula | string | optional | Formula, for fieldType calculation_equation. |
Example Request (cURL) · bash
curl --location --request POST 'https://api-proxy-v1.rubikchat.com/api/crm/v3/properties/contacts' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'X-Organization-Slug: your-organization-slug' \
--header 'Content-Type: application/json' \
--data '{
"name": "favorite_color",
"label": "Favorite color",
"description": "The color the contact likes most.",
"groupName": "contactinformation",
"type": "enumeration",
"fieldType": "select",
"formField": true,
"options": [
{
"label": "Red",
"value": "red",
"displayOrder": 0
},
{
"label": "Blue",
"value": "blue",
"displayOrder": 1
}
]
}'Status: 201 Created
Example Response · json
{
"name": "favorite_color",
"label": "Favorite color",
"description": "The color the contact likes most.",
"groupName": "contactinformation",
"type": "enumeration",
"fieldType": "select",
"options": [
{
"label": "Red",
"value": "red",
"displayOrder": 0,
"hidden": false
},
{
"label": "Blue",
"value": "blue",
"displayOrder": 1,
"hidden": false
}
],
"displayOrder": 12,
"calculated": false,
"calculationFormula": null,
"externalOptions": false,
"hasUniqueValue": false,
"hidden": false,
"formField": true,
"archived": false,
"createdAt": "2026-11-12T10:00:00+00:00",
"updatedAt": "2026-11-12T10:00:00+00:00",
"modificationMetadata": {
"archivable": true,
"readOnlyDefinition": false,
"readOnlyValue": false
}
}Note
A property with the same name on the same object type gives 409 Conflict. A body that fails validation gives 400 with the field errors.
Update a property
Changes the label, description, group, options or display of a property.
PATCH/properties/{objectType}/{propertyName}
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| objectType | string | required | Object type id (0-1 contacts, 0-2 companies, 0-3 deals, 2-… custom objects) or its name, e.g. contacts. |
| propertyName | string | required | The internal name of the property, e.g. favorite_color. |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| label | string | optional | New label. |
| description | string | optional | New help text. |
| groupName | string | optional | Move the property to another group. |
| options | array | optional | Replaces all options of an enumeration property. |
| displayOrder | integer | optional | Position of the property. |
| hidden | boolean | optional | Hide or show the property. |
| formField | boolean | optional | Allow the property in forms. |
Example Request (cURL) · bash
curl --location --request PATCH 'https://api-proxy-v1.rubikchat.com/api/crm/v3/properties/contacts/favorite_color' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'X-Organization-Slug: your-organization-slug' \
--header 'Content-Type: application/json' \
--data '{
"label": "Favourite colour"
}'Status: 200 OK
Example Response · json
{
"name": "favorite_color",
"label": "Favourite colour",
"description": "The color the contact likes most.",
"groupName": "contactinformation",
"type": "enumeration",
"fieldType": "select",
"options": [
{
"label": "Red",
"value": "red",
"displayOrder": 0,
"hidden": false
},
{
"label": "Blue",
"value": "blue",
"displayOrder": 1,
"hidden": false
}
],
"displayOrder": 12,
"calculated": false,
"calculationFormula": null,
"externalOptions": false,
"hasUniqueValue": false,
"hidden": false,
"formField": true,
"archived": false,
"createdAt": "2026-11-12T10:00:00+00:00",
"updatedAt": "2026-11-12T11:30:00+00:00",
"modificationMetadata": {
"archivable": true,
"readOnlyDefinition": false,
"readOnlyValue": false
}
}The name and type of a property cannot be changed.
Delete a property
Archives a property you created. Built-in properties cannot be deleted (404).
DELETE/properties/{objectType}/{propertyName}
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| objectType | string | required | Object type id (0-1 contacts, 0-2 companies, 0-3 deals, 2-… custom objects) or its name, e.g. contacts. |
| propertyName | string | required | The internal name of the property, e.g. favorite_color. |
Example Request (cURL) · bash
curl --location --request DELETE 'https://api-proxy-v1.rubikchat.com/api/crm/v3/properties/contacts/favorite_color' \
--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.
Property groups
Lists the groups used by the properties of an object type. Use a group's
name as groupName when you create a property.GET/properties/{objectType}/groups
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| objectType | string | required | Object type id (0-1 contacts, 0-2 companies, 0-3 deals, 2-… custom objects) or its name, e.g. contacts. |
Example Request (cURL) · bash
curl --location --request GET 'https://api-proxy-v1.rubikchat.com/api/crm/v3/properties/contacts/groups' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'X-Organization-Slug: your-organization-slug' \
--header 'Accept: application/json'Status: 200 OK
Example Response · json
{
"results": [
{
"name": "contactinformation",
"displayOrder": 0,
"label": "Contactinformation"
},
{
"name": "custom",
"displayOrder": 0,
"label": "Custom"
}
]
}Read several properties
Reads several properties by name in one request.
POST/properties/{objectType}/batch/read
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| objectType | string | required | Object type id (0-1 contacts, 0-2 companies, 0-3 deals, 2-… custom objects) or its name, e.g. contacts. |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| inputs | array | required | The properties to read: [{ name }]. |
Example Request (cURL) · bash
curl --location --request POST 'https://api-proxy-v1.rubikchat.com/api/crm/v3/properties/contacts/batch/read' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'X-Organization-Slug: your-organization-slug' \
--header 'Content-Type: application/json' \
--data '{
"inputs": [
{
"name": "email"
},
{
"name": "favorite_color"
}
]
}'Status: 200 OK
Example Response · json
{
"status": "COMPLETE",
"results": [
{
"name": "email",
"label": "Email",
"description": "",
"groupName": "contactinformation",
"type": "string",
"fieldType": "text",
"options": [],
"displayOrder": 3,
"calculated": false,
"calculationFormula": null,
"externalOptions": false,
"hasUniqueValue": false,
"hidden": false,
"formField": false,
"archived": false,
"createdAt": "2026-11-12T10:00:00+00:00",
"updatedAt": "2026-11-12T10:00:00+00:00",
"modificationMetadata": {
"archivable": false,
"readOnlyDefinition": true,
"readOnlyValue": true
}
},
{
"name": "favorite_color",
"label": "Favorite color",
"description": "The color the contact likes most.",
"groupName": "contactinformation",
"type": "enumeration",
"fieldType": "select",
"options": [
{
"label": "Red",
"value": "red",
"displayOrder": 0,
"hidden": false
},
{
"label": "Blue",
"value": "blue",
"displayOrder": 1,
"hidden": false
}
],
"displayOrder": 12,
"calculated": false,
"calculationFormula": null,
"externalOptions": false,
"hasUniqueValue": false,
"hidden": false,
"formField": true,
"archived": false,
"createdAt": "2026-11-12T10:00:00+00:00",
"updatedAt": "2026-11-12T10:00:00+00:00",
"modificationMetadata": {
"archivable": true,
"readOnlyDefinition": false,
"readOnlyValue": false
}
}
],
"startedAt": "2026-11-12T10:00:00Z",
"completedAt": "2026-11-12T10:00:00Z"
}