Skip to main content
PUT
Update custom field

Authorizations

Authorization
string
header
required

API token in the sk_live_… format.

Path Parameters

id
integer
required

Body

application/json
name
string
required

Display name.

Maximum string length: 60
Example:

"Plano"

application
enum<string>
required

Where the field applies: contact for contacts, card for CRM cards.

Available options:
contact,
card
type
enum<string>
required

Type of value accepted. It defines the validation applied on each save:

Available options:
text,
number,
currency,
date,
select,
boolean,
email,
phone,
link,
textarea
key
string

If you leave it out, the key is generated from the name, in minusculas_com_underline format (lowercase with underscores).

Maximum string length: 40
Example:

"plano"

description
string | null

Description of the custom field.

Maximum string length: 120
groupName
string | null

Group the field belongs to in the form. Fields in the same group appear together.

Example:

"Comercial"

isPublic
boolean
default:true

Makes the field visible to all agents. When false, only users with permission can see it.

alwaysVisible
boolean
default:false

Shows the field on the record even when no value is filled in.

options
object[]

List of options. Required when type is select.

Response

OK

data
object
Example: