LegacyCustomObjects
Create, delete, update, and query Legacy Custom Objects in Zendesk.
The legacy custom objects API is deprecated and has limited access. Accounts not already using the legacy API cannot start using it. Beginning January 2026, accounts already utilizing the legacy API will no longer be able to create new objects. Beginning June 2026, the legacy API will be sunset entirely.
Select
The LegacyCustomObjects table supports the ObjectName column in the WHERE clause. This table supports the following operator: '='.
For example:
SELECT * FROM LegacyCustomObjects WHERE ObjectName = 'house'
Insert
You can insert any field into the LegacyCustomObjects table that is not read-only. To insert Properties details for a custom object, use the #TEMP table to insert the fields of the property. The fields of the Property are present in the LegacyCustomObjectField view.
For Example:
INSERT INTO LegacyCustomObjectField#TEMP (FieldName, Type, Description, Required) VALUES ('NumOfRooms', 'integer', 'The number of rooms.', true)
INSERT INTO LegacyCustomObjectField#TEMP (FieldName, Type, Description, Required) VALUES ('NumOfBaths', 'integer', 'The number of baths.', true)
INSERT INTO LegacyCustomObjectField#TEMP (FieldName, Type, Description, Required) VALUES ('Balcony', 'boolean', 'Whether or not balcony is there.', true)
INSERT INTO LegacyCustomObjectField#TEMP (FieldName, Type, Description) VALUES ('PropertyAge', 'string', 'Old or new construction.')
INSERT INTO LegacyCustomObjects (ObjectName, Properties) VALUES ('house', LegacyCustomObjectField#TEMP)
Update
You can update only Properties column in the LegacyCustomObjects Table. To update the properties details for a custom object, Use the #TEMP table to insert the fields of the property. The fields of the Property is present in LegacyCustomObjectField view.
INSERT INTO LegacyCustomObjectField#TEMP (FieldName, Type, Description, Required) VALUES ('CarParking', 'string', 'Whether or not car parking is available', true)");
INSERT INTO LegacyCustomObjectField#TEMP (FieldName, Required) VALUES ('balcony', false)");
UPDATE LegacyCustomObjects SET Properties = 'LegacyCustomObjectField#TEMP' WHERE ObjectName = 'house'");
Delete
To delete a Custom Object, the ObjectName is required.
DELETE FROM LegacyCustomObjects WHERE ObjectName = 'house'
Columns
| Name | Type | ReadOnly | References | Description |
| ObjectName [KEY] | String | False |
A user-defined unique identifier. Writable on create only. | |
| CreatedAt | Datetime | True |
The time the object type was created. | |
| UpdatedAt | Datetime | True |
The time of the last update of the object type. | |
| Version | String | False |
The version of this schema. | |
| Properties | String | False |
A description of the object record, up to a maximum of 32 KB. |