API Reference

Update a custom field

put
https://{domain_prefix}.retail.lightspeed.app/api/2026-04/workflows/custom_fields/

Updates properties on a custom field.

🔒 Requires: custom_fields:write scope

Path Params
string
required

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

Body Params
boolean

Should this custom field be editable in the UI.

boolean

Should this custom field be printed on receipts.

string
boolean

Should this custom field be visible in the UI.

Response

Updated 3 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 months ago