Set a single custom field value

Management Sets or clears the value of a single custom field. Passing null as the value clears the field.

patch

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

You can refresh token using refresh_token that was given during login.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Path parameters

storeCodestringRequired

Store code

entityTypestring · enumRequired

Entity type the custom field is associated with.

Possible values:

entityIdstringRequired

ID of the entity to update

groupKeystringRequired

Group key containing the field

fieldKeystringRequired

Field key to update

Body

valueany ofRequired

Value to set. Pass null to clear the field. Type depends on the field's fieldType: text → string, integer → integer, float → number, boolean → boolean, single_select → string, multi_select → array of strings.

string · nullableOptional

or

integer · nullableOptional

or

number · nullableOptional

or

boolean · nullableOptional

or

string[] · nullableOptional

or

object[] · nullableOptional

Responses

204

Value set successfully

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

patch/api/{storeCode}/custom-fields/{entityType}/{entityId}/{groupKey}/{fieldKey}

PATCH /api/{storeCode}/custom-fields/{entityType}/{entityId}/{groupKey}/{fieldKey} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "value": "text"
}

No content