Custom Fields

Custom Fields V2 API

Custom fields are data points that allow you to capture and store specific information tailored to your business requirements. You can create fields across field types like text, numeric, selection options and special fields like date/time or signature

Servidor base: https://services.leadconnectorhq.com

Endpoints

• GET /custom-fields/{id} — Obtener Custom Field / Folder By Id
• PUT /custom-fields/{id} — Actualizar Custom Field By Id
• DELETE /custom-fields/{id} — Eliminar Custom Field By Id
• GET /custom-fields/object-key/{objectKey} — Obtener Custom Fields By Object Key
• POST /custom-fields/folder — Crear Custom Field Folder
• PUT /custom-fields/folder/{id} — Actualizar Custom Field Folder Name
• DELETE /custom-fields/folder/{id} — Eliminar Custom Field Folder
• POST /custom-fields/ — Crear campo personalizado

GET /custom-fields/{id}

Obtener Custom Field / Folder By Id

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

Scopes requeridos: locations/customFields.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

PUT /custom-fields/{id}

Actualizar Custom Field By Id

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

Scopes requeridos: locations/customFields.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) —

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location Id - name — string — Field name - description — string — Description of the field - placeholder — string — Placeholder text for the field - showInForms (requerido) — boolean — Whether the field should be shown in forms - options — array — Options for the field. Important: Providing options will completely replace the existing options array. You must include all existing options alongside any new options you wish to add. Removal of options is not supported through this update. Applicable only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST types. - key (requerido) — string — Key of the option (Included in Create and Response, excluded in Update) - label (requerido) — string — Value of the option - url — string — URL associated with the option (Optional, valid only for RADIO type) - acceptedFormats — string — Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all - maxFileLimit — number — Maximum file limit for uploads. Applicable only for fields with a data type of FILE_UPLOAD.

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

DELETE /custom-fields/{id}

Eliminar Custom Field By Id

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

Scopes requeridos: locations/customFields.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

GET /custom-fields/object-key/{objectKey}

Obtener Custom Fields By Object Key

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

Scopes requeridos: locations/customFields.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - objectKey (path, string) (requerido) — key of the Object. Must include "custom_objects." prefix for custom objects. Available on the Custom Objects details Page under settings - locationId (query, string) (requerido) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

POST /custom-fields/folder

Crear Custom Field Folder

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

Scopes requeridos: locations/customFields.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - objectKey (requerido) — string — The key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets. - name (requerido) — string — Field name - locationId (requerido) — string — Location Id

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

PUT /custom-fields/folder/{id}

Actualizar Custom Field Folder Name

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

Scopes requeridos: locations/customFields.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) —

Cuerpo de la peticion (application/json): - name (requerido) — string — Field name - locationId (requerido) — string — Location Id

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

DELETE /custom-fields/folder/{id}

Eliminar Custom Field Folder

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

Scopes requeridos: locations/customFields.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) — - locationId (query, string) (requerido) — Id de sede

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

POST /custom-fields/

Crear campo personalizado

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

Scopes requeridos: locations/customFields.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location Id - name — string — Field name - description — string — Description of the field - placeholder — string — Placeholder text for the field - showInForms (requerido) — boolean — Whether the field should be shown in forms - options — array — Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type) - key (requerido) — string — Key of the option (Included in Create and Response, excluded in Update) - label (requerido) — string — Value of the option - url — string — URL associated with the option (Optional, valid only for RADIO type) - acceptedFormats — string — Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all - dataType (requerido) — string — Type of field that you are trying to create - fieldKey (requerido) — string — 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. - objectKey (requerido) — string — The key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets. - maxFileLimit — number — Maximum file limit for uploads. Applicable only for fields with a data type of FILE_UPLOAD. - allowCustomOption — boolean — 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. - parentId (requerido) — string — Id of the parent folder

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado