Updates the member photo of the currently authenticated member

The photo is uploaded via a form-data key/value pair with type file and the key being "MemberPhoto".

The Photo file should be uploaded using the HTTP request body type form-data set to File, with a Key of MemberPhoto and Value of the photo file to be uploaded.

Supported photo file formats are: JPEG, BMP, PNG, HEIC, WebP. File size limit and photo dimensions are configured in Loyalty. The file size limit specifies and upper-bound on file size, while photo dimensions are an exact requirement.

An HTTP Bad Request is returned in the following cases:

  • No Loyalty member is currently logged in.
  • No photo is uploaded.
  • Based on Loyalty configuration, the Loyalty member isn't eligible to update their photo
  • The photo file size is too large.
  • The photo dimensions don't match the dimensions configured in Loyalty.
  • The photo format isn't accepted.

An HTTP Bad Gateway is returned if the connection to Loyalty times out.

Licenses Required

  • Vista.Ocapi
  • Vista.Loyalty.MemberPhotos
Request
header Parameters
loyaltySessionToken
string

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

Connect-Region-Code
string

Region Code

Request Body schema: multipart/form-data
ContentType
string
ContentDisposition
string
object
Length
integer <int64>
Name
string
FileName
string
Responses
200

Success

400

Provided photo does not meet configured requirements.

401

No member authenticated.

put/ocapi/v1/members/current/photo
Request samples
Response samples
application/json
{
  • "memberPhoto": {
    }
}