Skip to main content
PATCH
/
v1
/
custom-field
/
{id}
Update Custom Field
curl --request PATCH \
  --url https://api.nedzo.ai/v1/custom-field/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "field_key": "<string>",
  "data_type": "<string>"
}
'
{
  "status_code": 123,
  "message": "<string>",
  "data": {
    "custom_field": {
      "name": "<string>",
      "description": "<string>",
      "field_key": "<string>",
      "data_type": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subaccount_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string | null

The updated display name of the custom field.

description
string | null

An updated explanation of the custom field's purpose.

field_key
string | null

The updated unique identifier for the custom field.

data_type
string | null

The updated data type for the field (e.g., string, integer, boolean).

Response

Successful Response

status_code
integer
required
message
string
required
data
object | null