Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt

Use this file to discover all available pages before exploring further.

<div> <p> Create Custom Field </p> <div> <span style= “display: inline-block; width: 25px; height: 25px; background-color: yellow; color: black; font-weight: bold; font-size: 24px; text-align: center; line-height: 22px; border: 2px solid black; border-radius: 10%; margin-right: 10px;”> ! </span> <span> <strong> Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. </strong> </span> </div> </div> 
POST https://services.leadconnectorhq.com/custom-fields/

​
Autorizacion

​
Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticacion.
​
Version
string
default:"2021-07-28"
required
Version de la API.

​
Body

​
locationId
string
default:"ve9EPM428h8vShlRW1KT"
required
Account Id
​
name
string
default:"Name"
Field name
​
description
string
Description of the field
​
placeholder
string
Placeholder text for the field
​
showInForms
boolean
required
Whether the field should be shown in forms
​
options
object[]
Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)
​
acceptedFormats
string
Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all Posibles valores: ‘.pdf’, ‘.docx’, ‘.doc’, ‘.jpg’, ‘.jpeg’, ‘.png’, ‘.gif’, ‘.csv’, ‘.xlsx’, ‘.xls’, ‘all’
​
dataType
string
required
Type of field that you are trying to create Posibles valores: ‘TEXT’, ‘LARGE_TEXT’, ‘NUMERICAL’, ‘PHONE’, ‘MONETORY’, ‘CHECKBOX’, ‘SINGLE_OPTIONS’, ‘MULTIPLE_OPTIONS’, ‘DATE’, ‘TEXTBOX_LIST’, ‘FILE_UPLOAD’, ‘RADIO’, ‘EMAIL’
​
fieldKey
string
default:"custom_object.pet.name"
required
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
string
default:"custom_object.pet"
required
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
default:"2"
Maximum file limit for uploads. Applicable only for fields with a data type of FILE_UPLOAD.
​
allowCustomOption
boolean
default:"True"
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
string
required
ID of the parent folder

​
Respuestas

​
field
object
{
  "field": {
    "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": "2024-01-15T10:30:00Z",
    "dateUpdated": "2024-01-15T10:30:00Z"
  }
}

{}

{}

​
Ejemplo

curl -X POST 'https://services.leadconnectorhq.com/custom-fields/' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "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"
}'