Update profile

This endpoint is used to update a customer's profile. The profile contains information such as the customer's first_name, last_name, birthday, gender, and avatar.

Payload `authenticated`

UpdateProfilePayload

first_name

string

required

Customer first name.

last_name

string

required

Customer last name

birthday

string

optional

Customer date of birth.

Example:

2022-02-22

gender

enum<string>

optional

Customer gender.

Allowed values:

malefemale

string

required

Customer email.

mobile

string

required

Customer mobile.

country_code

string

required

Customer code of country.

Default:

country_key

string

required

Customer key of country.

Default:

+966

avatar

object

BinaryType

optional

Customer profile's avatar image.

Response

Success

Error

UpdateProfileSuccess

success

boolean

success

required

Response flag

status

enum<number>

status

required

Allowed values:

200201202

data

object

data

optional

Response data.

first_name

string

first_name

required

Customer first name

last_name

string

last_name

required

Customer last name

phone

object

phone

required

Customer phone number

string

required

Customer email

avatar

string

avatar

required

Customer avatar

gender

optional

Customer gender

birthday

string

birthday

required

Customer date of birth

verification

object

optional

The verification details

Usage

To update the content of the customer's profile, the developer may call the methos update() along with the customer's new information as below.

in case the user change the phone/email a OTP required to complete the changes, you can take advancige of salla-verify-modal to hanlde the OTP verifation

Without web componenet

Events

This endpoint may trigger two events, the onUpdated and onUpdateFailed events.

onUpdated

This event is triggered when updating the content of the customer's profile is done without having any errors coming back from the backend.

onUpdateFailed

This event is triggered when updating the content of the customer's profile is not completed and an error has occurred.

Payload authenticated#

Response#

Usage#

Without web componenet#

Events#

onUpdated#

onUpdateFailed#

Payload `authenticated`

Response

Usage

Without web componenet

Events

onUpdated

onUpdateFailed