API Reference

Set new custom field values

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

Set new custom field values on a given entity.

🔒 Requires: custom_fields:write scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The parameters that can be passed to the set custom field values API.

string
enum
required

The entity type.

Allowed:
uuid
required

The ID of entity.

values
array of objects
required

The values.

values*
Response

Updated about 1 month ago

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

Updated about 1 month ago