WAwafeq
Custom Fields

Partial update custom field

Changed on

Endpoint for partially updating an existing custom field.

patch/custom-fields/{id}/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/custom-fields/{id}/
  • Auth
    API key in header Authorization

Path parameters

idstring required

A unique value identifying this custom field.

Headers

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

apply_toApplyToEnum[]

The groups this custom field applies to.

View the enum reference

is_activeboolean

Whether the custom field is active.

is_line_item_fieldboolean

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

is_visibleboolean

Whether the custom field is visible.

namestring

The english name of the custom field.

name_arstring

The arabic name of the custom field.

Response

apply_toApplyToEnum[] required

The groups this custom field applies to.

View the enum reference

created_tsstring date-time required

The timestamp in UTC when the custom field was created.

field_type'TEXT' | 'LONG_TEXT' | 'NUMBER' | 'DATE' | 'SELECT' | 'LOOKUP' | 'CALCULATED' required

Data type of a custom field.

View the enum reference

idstring required

The unique identifier of the custom field.

is_activeboolean

Whether the custom field is active.

is_line_item_fieldboolean

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

modified_tsstring date-time required

The timestamp in UTC when the custom field was last modified.

namestring

The English name of the custom field.

name_arstring

The Arabic name of the custom field.

Changes

  • b8f5e10134b4Revision changes
    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed the permission_denied enum value from the response property for the response status

    • info

      removed the validation_error enum value from the response property for the response status

    • info

      added the required property to the response with the status