Skip to main content
PUT
Update custom field by ID
Body raw (json)

Authorizations

x-api-key
string
header
required

Path Parameters

customfieldId
string
required

Body

application/json
name
string
required
Maximum string length: 255
position
number
permission
string

Comma-separated string of user rules, for example 1,2,3.

Maximum string length: 255
is_active
boolean
object
enum<string>

The type of custom field.

Available options:
customer,
job,
project,
invoice,
asset,
job_visit,
maintenance_agreement,
order
can_customer_view
boolean
field_widget_id
integer

Existing custom field widget id.

settings
object

Response

Successful response

error
boolean

false when the request succeeds.

Example:

false

response
object

The updated record.