Get Custom Field

GEThttps://services.leadconnectorhq.com/locations/{locationId}/customFields/{id}
Create Custom Field

Request

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123
Path Parameters
id
string
required

Custom Field Id or Field Key (e.g. "contact.first_name" or "opportunity.pipeline_id")

Examples:
00NhGCcN1tlO8ZHcu7Wbcontact.first_name
locationId
string
required

Location Id

Example:
ve9EPM428h8vShlRW1KT
Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-07-28

Responses

Successful response

Body

customField
object
id
string
Example:
3sv6UEo51C9Bmpo1cKTq
name
string
Example:
pincode
fieldKey
string
Example:
contact.pincode
placeholder
string
Example:
Pin code
dataType
string
Example:
TEXT
position
number
Example:
0
picklistOptions
array[string]
Example:
["first option"]
picklistImageOptions
array[string]
Example:
[]
isAllowedCustomOption
boolean
Example:
false
isMultiFileAllowed
boolean
Example:
true
maxFileLimit
number
Example:
4
locationId
string
Example:
3sv6UEo51C9Bmpo1cKTq
model
string

Model of the custom field

Allowed values:
contactopportunity
Example:
opportunity

Unprocessable Entity

Body

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request