Check User Data Type Name Existence

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

This API can be used to check if a specified custom data type name is already defined in the system

Request URL

https://{serverurl}/dcapi/customColumn/udtNameExists

Scope

DesktopCentralCloud.CustomField.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/udtExistsDetails.v1+jsonapplication/udtExistsDetails.v1+jsonCopied!

- Query Parameters

udtNamestringMandatory

The name of the custom data type to check for existence

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomains/dcapi/customColumn/udtNameExists?udtName=SOME_STRING_VALUE' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/udtExistsDetails.v1+json'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
existsboolean

Indicates whether the specified custom data type name already exists in the system (true/false)

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "exists": true
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.