Ctrlk
HomepageCase studiesBook a demo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update member’s details

Management This method allows updating data related to a specific Member account. If a member changes the primary identification method then this change has to be confirmed. Confirmation works only for email and phone fields. If CustomerEmailWasChanged or CustomerPhoneNumberWasChanged webhook is configured, the code, code number, and member contact data will be transmitted. Field code from the webhook has to be used as token parameter in endpoint. confirm change

put
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
memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+
storeCodestringRequired

Store code

Body
Responses
200

Return updated member id.

application/json
customerIdstringOptional

Updated member identity

Example: 00000000-0000-0000-0000-000000000000
put/api/{storeCode}/member/{member}
PUT /api/{storeCode}/member/{member} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "customer": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "example@example.com"
  }
}
{
  "customerId": "00000000-0000-0000-0000-000000000000"
}

Last updated

Was this helpful?