BadRequestDTO
{
"statusCode": 400,
"message": "Bad Request"
}
UnauthorizedDTO
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
UnprocessableDTO
{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}
CustomObjectLabelDto
Singular name of the custom object
Plural name of the custom object
{
"singular": "Pet",
"plural": "Pets"
}
ICustomObjectSchema
id of the custom / standard object schema
false in case of custom objects and true in case of standard objects like contacts and opportunities
key that would be used to refer the custom / standard Object internally (lowercase + underscore_separated). For custom objects, 'custom_objects.' would be added as prefix by default
This is what your custom / standard object will be called. These labels will be used to display your custom object on the UI
Singular name of the custom object
Plural name of the custom object
Custom / Standard Object Descriptions for example , Pet Object`s description
location's id
Primary property for the custom / standard Object. This would be used as primary data when rendering the UI. 'custom_objects.{{object_key}} or business.{{object_key}} (for company)' would be added as prefix by default for all the custom / standard objects
Date and time when the object was added
Date and time when the object was last updated
Object`s Type
{
"id": "661c06b4ffde146bdb469442",
"standard": false,
"key": "custom_objects.pet",
"labels": {
"singular": "Pet",
"plural": "Pets"
},
"description": "These are non vaccinated pets",
"locationId": "Q9DT3OAqEXDLYuob1G32",
"primaryDisplayProperty": "custom_objects.pet.name",
"dateAdded": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"type": "The Object type can either USER_DEFINED or SYSTEM_DEFINED"
}
OptionDTO
Key of the option (Included in Create and Response, excluded in Update)
Value of the option
URL associated with the option (Optional, valid only for RADIO type)
{
"key": "string",
"label": "string",
"url": "string"
}
ICustomField
Location Id
Field name
Description of the field
Placeholder text for the field
Whether the field should be shown in forms
Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)
Key of the option (Included in Create and Response, excluded in Update)
Value of the option
URL associated with the option (Optional, valid only for RADIO type)
Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all
Unique identifier of the object
The key for your custom / standard object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.
Type of field that you are trying to create
ID of the parent folder
Field key. For Custom Object it's formatted as "custom_object.{objectKey}.{fieldKey}". "custom_object" is a fixed prefix, "{objectKey}" is your custom object's identifier, and "{fieldName}" is the unique field name within that object. Example: "custom_object.pet.name" for a "name" field in a "pet" custom object.
Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.
Maximum file limit for uploads
Date and time when the object was added
Date and time when the object was last updated
{
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "Name",
"description": "string",
"placeholder": "string",
"showInForms": true,
"options": [
{
"key": "string",
"label": "string",
"url": "string"
}
],
"acceptedFormats": ".pdf",
"id": "string",
"objectKey": "custom_object.pet",
"dataType": "TEXT",
"parentId": "3v34PM428h8vShlRW1KT",
"fieldKey": "custom_object.pet.name",
"allowCustomOption": true,
"maxFileLimit": 2,
"dateAdded": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z"
}
CustomObjectByIdResponseDTO
id of the custom / standard object schema
false in case of custom objects and true in case of standard objects like contacts and opportunities
key that would be used to refer the custom / standard Object internally (lowercase + underscore_separated). For custom objects, 'custom_objects.' would be added as prefix by default
This is what your custom / standard object will be called. These labels will be used to display your custom object on the UI
Custom / Standard Object Descriptions for example , Pet Object`s description
location's id
Primary property for the custom / standard Object. This would be used as primary data when rendering the UI. 'custom_objects.{{object_key}} or business.{{object_key}} (for company)' would be added as prefix by default for all the custom / standard objects
Date and time when the object was added
Date and time when the object was last updated
Object`s Type
Is the response served from cache
Location Id
Field name
Description of the field
Placeholder text for the field
Whether the field should be shown in forms
Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)
Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all
Unique identifier of the object
The key for your custom / standard object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.
Type of field that you are trying to create
ID of the parent folder
Field key. For Custom Object it's formatted as "custom_object.{objectKey}.{fieldKey}". "custom_object" is a fixed prefix, "{objectKey}" is your custom object's identifier, and "{fieldName}" is the unique field name within that object. Example: "custom_object.pet.name" for a "name" field in a "pet" custom object.
Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.
Maximum file limit for uploads
Date and time when the object was added
Date and time when the object was last updated
{
"object": {
"id": "661c06b4ffde146bdb469442",
"standard": false,
"key": "custom_objects.pet",
"labels": {
"singular": "Pet",
"plural": "Pets"
},
"description": "These are non vaccinated pets",
"locationId": "Q9DT3OAqEXDLYuob1G32",
"primaryDisplayProperty": "custom_objects.pet.name",
"dateAdded": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"type": "The Object type can either USER_DEFINED or SYSTEM_DEFINED"
},
"cache": true,
"fields": [
{
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "Name",
"description": "string",
"placeholder": "string",
"showInForms": true,
"options": [
{}
],
"acceptedFormats": ".pdf",
"id": "string",
"objectKey": "custom_object.pet",
"dataType": "TEXT",
"parentId": "3v34PM428h8vShlRW1KT",
"fieldKey": "custom_object.pet.name",
"allowCustomOption": true,
"maxFileLimit": 2,
"dateAdded": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z"
}
]
}
CustomObjectListResponseDTO
id of the custom / standard object schema
false in case of custom objects and true in case of standard objects like contacts and opportunities
key that would be used to refer the custom / standard Object internally (lowercase + underscore_separated). For custom objects, 'custom_objects.' would be added as prefix by default
This is what your custom / standard object will be called. These labels will be used to display your custom object on the UI
Custom / Standard Object Descriptions for example , Pet Object`s description
location's id
Primary property for the custom / standard Object. This would be used as primary data when rendering the UI. 'custom_objects.{{object_key}} or business.{{object_key}} (for company)' would be added as prefix by default for all the custom / standard objects
Date and time when the object was added
Date and time when the object was last updated
Object`s Type
{
"objects": [
{
"id": "661c06b4ffde146bdb469442",
"standard": false,
"key": "custom_objects.pet",
"labels": {
"singular": "Pet",
"plural": "Pets"
},
"description": "These are non vaccinated pets",
"locationId": "Q9DT3OAqEXDLYuob1G32",
"primaryDisplayProperty": "custom_objects.pet.name",
"dateAdded": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"type": "The Object type can either USER_DEFINED or SYSTEM_DEFINED"
}
]
}