Update custom field

put

https://api.wafeq.com/v1/custom-fields/{id}/

Endpoint for updating an existing custom field.

Path Params

string

required

A unique value identifying this custom field.

Body Params

The payload to create or update a custom field.

apply_to

array of objects

required

The groups this custom field applies to.

View the enum reference

apply_to*

Allowed:

config

required

The configuration of the custom field, containing field_type and metadata. The metadata structure depends on field_type: SELECT fields include a choices array, LOOKUP fields include an entity_type, and other types have empty metadata.

is_active

boolean

Whether the custom field is active.

is_line_item_field

boolean

Whether the custom field is set on line items instead of on the document.

is_visible

boolean

Whether the custom field is visible.

name

string

length ≤ 100

The english name of the custom field.

name_ar

string

length ≤ 100

The arabic name of the custom field.

Headers

X-Wafeq-Idempotency-Key

string

Client-provided UUID to uniquely identify a request

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200

400Validation error (e.g., invalid config, field type change while in use, or choice removal while in use).

403Permission denied or addon limit reached.