Defines the custom objects available in the Zendesk account.

Table-Specific Information

Custom objects are configured using the CustomObjects and CustomObjectFields tables. The CustomObjects table essentially allows you to list and create custom objects, while the CustomObjectFields table allows you to query and modify the fields of the custom objects. Records within these custom objects are then queried and modified via tables with the "CustomObject_" prefix (see Working with Custom Object Records).

Tip: If custom objects are already defined in the Zendesk UI, you can query and modify records directly in the CustomObject_Name tables without needing to configure the corresponding tables.

Select

The following query shows all custom objects available in the account:

SELECT * FROM CustomObjects

Insert

You must specify the Key, Title, and TitlePluralized columns in order to create a new custom object.

Insert into CustomObjects (Key, Title, TitlePluralized, Description) values ('Devices', 'Device', 'Devices', 'Devices available')

Update

You must specify the Key column to update a custom object.

Update CustomObjects SET Description='Devices available in central office' WHERE Key='Devices'

Delete

You must specify the Key column to delete a custom object.

Delete FROM CustomObjects WHERE Key='Devices'

Working with Custom Object Records

Records within the custom objects are queried and modified via tables with the "CustomObject_" prefix. For example, a custom object within Zendesk named "Devices" will have the name "CustomObject_Devices". The columns available for the custom object are observable and modified via the CustomObjectFields table.

Select Custom Object Records

SELECT * FROM CustomObject_Devices

Insert Custom Object Records

You must specify a Name for each record within a custom object. Name and Description are standard columns available in all custom object tables. In the example below, the Units column is specific to this custom object and would be specified in the CustomObjectFields table.

Insert into CustomObject_Devices (Name, Description, Units) values ('WinPCs', 'Windows machines', 10)

Update Custom Object Records

You must specify the Id of a record to perform updates, which is a standard column across all custom object records.

Update CustomObject_Devices SET Description='Windows machines in storage' WHERE Id='01KE84AVNNH93GXYSCE6H0V74R'

Delete Custom Object Records

You must specify the Id of a record to delete it.

Delete FROM CustomObject_Devices WHERE Id='01KE84AVNNH93GXYSCE6H0V74R'

Columns

Name	Type	ReadOnly	References	Description
Key [KEY]	String	False		A user-defined unique identifier. Writable on create only.
Title	String	False		User defined display name for the object.
TitlePluralized	String	False		User defined pluralized version of the object's title.
RawTitle	String	False		The dynamic content placeholder, if present, or the Title value, if not.
RawTitlePluralized	String	False		The dynamic content placeholder, if present, or the RawTitlePluralized value, if not.
Description	String	False		User defined description of the object.
RawDescription	String	False		The dynamic content placeholder, if present, or the RawDescription value, if not.
CreatedAt	Datetime	False		The time the object type was created.
CreatedBy	Long	False	Users.Id	Id of a user who created the object.
CreatedVia	String	False		Source from which the object was created
UpdatedAt	Datetime	False		The time of the last update of the object.
UpdatedBy	Long	False	Users.Id	Id of the last user who updated the object.
AllowsAttachments	Boolean	False		If true, file attachments can be added to the object's records.
AllowsPhotos	Boolean	False		If true, photos can be uploaded to the records of the object.
IncludeInListView	Boolean	False		A flag setting the visibility of the object in the agent's list view.
Url	String	False		Direct link to the specific custom object.