Sign in

v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB
Members

Updates the member personal details of the currently authenticated member

Full personalDetails object from GetMember containing updated values must be sent to this endpoint. If field is not provided then it's considered that it must be cleared.

Note: currently Vista Loyalty doesn't support clearing fields. Also enum fields don't support setting value 0 where it is equivalent of clearing field (e.g. NotSpecified)

Licenses Required

  • Vista.Ocapi
put/ocapi/v1/members/current/personal-details

Headers

loyaltySessionTokenstring

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Codestring

Region Code

Request body

birthDatestring date-time nullable

Gets the date of birth, if known

maritalStatus'NotSpecified' | 'Single' | 'Married' | 'Partnered' | 'Divorced' | 'Other' required

Represents the marital status of a member

gender'NotSpecified' | 'Male' | 'Female' | 'Other' required

Represents the gender of a member

educationLevelIdinteger nullable

Gets the unique identifier of the education level, if known

occupationIdinteger nullable

Gets the unique identifier of the occupation, if known

householdPersonCountinteger nullable

Gets the number of people living in the household, if known

nationalIdstring nullable

Gets the national unique identifier, if known

externalIdstring nullable

Gets the unique identifier used in a previous loyalty system, if known

Example request

{
  "contactDetails": {
    "address": {
      "line1": "60 Khyber Pass Road",
      "suburb": "Grafton",
      "city": "Auckland",
      "postCode": "1023",
      "country": "New Zealand"
    }
  },
  "preferences": {
    "languageTag": "en-US"
  }
}

Response

Member personal details updated.