Remove all custom field values in a group
Management
Removes all stored custom field values for the given group on the entity. The operation is idempotent: a 204 is returned whenever the entity and group resolve, regardless of how many values were actually stored. A 404 is returned when the entity does not exist or the group key does not resolve to an existing group definition. A 400 is returned when the entity exists but does not match the given entity type.
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
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.
To refresh admin token POST /api/token/refresh Go to definition
Store code
Entity type the custom field is associated with.
ID of the entity to remove custom field values from
Group key whose values are removed
Success. No content.
No content
Bad request.
Unauthorized
Forbidden.
Not found.
DELETE /api/{storeCode}/custom-fields/{entityType}/{entityId}/{groupKey} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated
Was this helpful?

