customer/v1/profile
[GET] /customer/v1/profile
Get customer profile
The customer retrieves their profile details using the get profile endpoint, based on the customer access token passed in the request header.
Example [GET] Request
{{avenu_base_url}}/customer/v1/profile
Example Response
{
"address": "",
"city": "",
"state": "",
"zipCode": "",
"country": "",
"citizenship": "",
"email": "",
"mobilePhone": ""
}
Response Elements
Parameter | Format |
---|---|
"address" | Customer's street address |
"city" | Customer's city |
"state" | Customer's state |
"zipCode" | Customer's ZIP |
"country" | 3 character country code |
"citizenship" | 3 character country code of citizenship |
"email" | Customer's email address |
"mobilePhone" | Customer's mobile phone |
[PUT] /customer/v1/profile
Update customer profile
The customer updates their profile details using the profile endpoint, based on the customer access token passed in the request header.
Example [PUT] Request
{{avenu_base_url}}/customer/v1/profile
{
"address": "",
"city": "",
"state": "",
"zipCode": "",
"country": "",
"citizenship": "",
"email": "",
"mobilePhone": ""
}
Input parameters
Parameter | Format | Required |
---|---|---|
"address" | String | Y |
"city" | String | Y |
"state" | String | Y |
"zipCode" | String | N |
"country" | String; ISO 3166 Alpha-3 country code | Y |
"citizenship" | String; ISO 3166 Alpha-3 country code | N |
"email" | String | Y |
"mobilePhone" | String | Y |
Note: citizenship
is not editable or updatable through this endpoint.
Example Response
{
"address": "",
"city": "",
"state": "",
"zipCode": "",
"country": "",
"citizenship": "",
"email": "",
"mobilePhone": ""
}
Response Elements
Parameter | Format |
---|---|
"address" | Customer's street address |
"city" | Customer's city |
"state" | Customer's state |
"zipCode" | Customer's ZIP |
"country" | 3 character country code |
"citizenship" | 3 character country code of citizenship |
"email" | Customer's email address |
"mobilePhone" | Customer's mobile phone |
Errors
code | Message |
---|---|
1001 | "Missing required field" |
1002 | "Error - Invalid data structure" |
1003 | "Error - Invalid data" |
Updated over 1 year ago