Skip to content
Annex Cloud/
Customer Loyalty
/
/
Used to update multiple l...

Used to update multiple loyalty member profiles

Request

This endpoint enables updating member information efficiently in bulk. NOTE - We recommend limiting requests to around 100 records. Note: For all date-time fields in the request and response, if the timestamp contains a timezone offset after the + symbol (for example, 2024-07-21T12:30:45+05:30), the value after + will be ignored during processing. Only the date and time portion before the + sign will be considered.

Security
MuseumPlaceholderAuth
Bodyapplication/json
idstring

Enter the unique ID of the loyalty member.

Example:"advinsap24"
emailstring

Enter the email address of the loyalty member.

Example:"advinsap24@gmail.com"
firstNamestring

Enter the first name of the loyalty member.

Example:"Advin"
lastNamestring

Enter the last name of the loyalty member.

Example:"Roy"
optInStatusstring

Enter the opt-in status as YES for opt-in or NO for opt-out. The default opt-in status is YES.

Example:"YES"
statusstring

If the activity-based membership status flag is OFF- Enter the loyalty member’s status as active or inactive. By default, the status is active and can be changed to inactive as per the client’s request. If the activity-based membership status flag is ON- Any values submitted in the status parameter will be ignored. The system automatically manages member status based on the defined activity-based criteria.

Example:"ACTIVE"
extendedAttributeobject

Enter the member attributes defined in your program configuration. This can be customized according to requirements. It accepts multiple parameters; however, these parameters must be defined under Products > Additional Loyalty Settings > Extended Attributes. Note - The extended attributes listed below are examples only. All extended attributes must be configured for the program as stated above.

POST
/bulkpatchusers
curl -i -X POST \
  https://s15.socialannex.net/api/3.0/bulkpatchusers \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "advinsap24",
    "email": "advinsap24@gmail.com",
    "firstName": "Advin",
    "lastName": "Roy",
    "optInStatus": "YES",
    "status": "ACTIVE",
    "extendedAttribute": {
      "userType": "Employed",
      "userStatus": "Enabled"
    }
  }'

Responses

successful operation

Body
siteIdstring

Displays Annex Cloud site ID for the loyalty program.

Example:146032020
idstring

Displays the unique ID of the loyalty member.

Example:"advinsap24"
emailstring

Displays the email address of the loyalty member.

Example:"advinsap24@gmail.com"
firstNamestring

Displays the first name of the loyalty member.

Example:"Advin"
lastNamestring

Displays the last name of the loyalty member.

Example:"Roy"
optInStatusstring

Displays the opt-in status as YES for opt-in or NO for opt-out. The default opt-in status is YES.

Example:"YES"
statusstring

If the activity-based membership status flag is OFF- Displays the loyalty member’s status as active or inactive. By default, the status is active and can be changed to inactive as per the client’s request. If the activity-based membership status flag is ON- Displays the member status based on the defined activity-based criteria.

Example:"ACTIVE"
phoneinteger

Displays the phone number of the loyalty member.

Example:4532678800
birthDatestring

Displays the date of birth of the loyalty member in yyyy-MM-dd’T’HH:mm:ssZ format.

Example:"2001-11-04T00:00:00-07:00"
anniversaryDatestring

Displays the loyalty member's anniversary date, which can be their birthdate, the date they joined the loyalty program or marriage date, in yyyy-MM-dd’T’HH:mm:ssZ format.

Example:"2021-11-04T00:00:00-07:00"
createDatestring

Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on which the loyalty member profile was created.

Example:"2024-04-25T04:17:39+0000"
updateDatestring

Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on which the loyalty member was updated.

Example:"2024-04-25T04:17:39+0000"
extendedAttributeobject

Displays the member attributes defined in your program configuration. This can be customized according to requirements. It accepts multiple parameters; however, these parameters must be defined under Products > Additional Loyalty Settings > Extended Attributes. Note - The extended attributes listed below are examples only. All extended attributes must be configured for the program as stated above.

Response
{
  "siteId": 146032020,
  "id": "advinsap24",
  "email": "advinsap24@gmail.com",
  "firstName": "Advin",
  "lastName": "Roy",
  "optInStatus": "YES",
  "status": "ACTIVE",
  "phone": 4532678800,
  "birthDate": "2001-11-04T00:00:00-07:00",
  "anniversaryDate": "2021-11-04T00:00:00-07:00",
  "createDate": "2024-04-25T04:17:39+0000",
  "updateDate": "2024-04-25T04:17:39+0000",
  "extendedAttribute": {
    "userType": "Employed",
    "userStatus": "Enabled"
  }
}