BadRequestDTO
{
"statusCode": 400,
"message": "Bad Request"
}
UnauthorizedDTO
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
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"
}
CustomFieldSuccessfulResponseDto
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
{
"field": {
"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"
}
}
CustomFieldsResponseDTO
Custom Fields for the object.
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
Custom Fields folder for the object.
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
{
"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"
}
],
"folders": [
{
"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"
}
]
}
CreateCustomFieldsDTO
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
Type of field that you are trying to create
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 "{fieldKey}" is the unique field name within that object. Example: "custom_object.pet.name" for a "name" field in a "pet" custom object.
The key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.
Maximum file limit for uploads. Applicable only for fields with a data type of FILE_UPLOAD.
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.
ID of the parent folder
{
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "Name",
"description": "string",
"placeholder": "string",
"showInForms": true,
"options": [
{
"key": "string",
"label": "string",
"url": "string"
}
],
"acceptedFormats": ".pdf",
"dataType": "TEXT",
"fieldKey": "custom_object.pet.name",
"objectKey": "custom_object.pet",
"maxFileLimit": 2,
"allowCustomOption": true,
"parentId": "string"
}
CreateFolder
The key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.
Field name
Location Id
{
"objectKey": "custom_object.pet",
"name": "Name",
"locationId": "ve9EPM428h8vShlRW1KT"
}
ICustomFieldFolder
Unique identifier of the object
The key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.
Location Id
Field name
{
"id": "string",
"objectKey": "custom_object.pet",
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "Name"
}
UpdateFolder
Field name
Location Id
{
"name": "Name",
"locationId": "ve9EPM428h8vShlRW1KT"
}