Update Custom Property

Updates an existing CustomProperty. The following fields can be updated:

  • label
  • required
  • default
  • references

The same validations apply as when creating a Custom Property. Note, that the type of a Custom Property cannot be changed, the reason for this is that the Custom Object Records that have a value for the Custom Property would be invalid if the type of the Custom Property was changed.

Updates to the references:

  • If a reference should be removed, the delete field of that reference should be set to true.
  • If an existing reference should be updated, the id field of that reference should be set to the ID of the existing reference.
  • If a new reference should be added, the existing list of references should be included in the payload and the new reference should be added to that list with the id and delete fields set to null.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Custom Object ID

string
required

Custom Property ID

Body Params

Custom Property Update

string

Additional context information for AI features

string

The default value of the Custom Property

boolean

Whether the Custom Property is editable

string

The label of the Custom Property

boolean

Whether the Custom Property is required

string

The state of the Custom Property

Responses

Callback
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json