Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Workflows

Update a custom field

Updates properties on a custom field.

🔒 Requires: custom_fields:write scope

put/workflows/custom_fields/{customFieldId}

Path parameters

customFieldIdstring required

The ID of the custom field that you want to update.

Request body

editable_in_uiboolean

Should this custom field be editable in the UI.

print_on_receiptboolean

Should this custom field be printed on receipts.

titlestring
visible_in_uiboolean

Should this custom field be visible in the UI.

Example request

{
  "title": "My Custom Field"
}

Response

A custom field definition.

Example response

{
  "data": {
    "id": "1239349157873029120",
    "name": "my_custom_field",
    "title": "My Custom Field"
  }
}