7x Developer Portal & API Documentation

Loading developer portal

Preparing the API reference and documentation.

Overview

Updates customer profile attributes such as names, language, and contact information. Input validation is enforced against the UpdateRequest schema before persisting changes.

Request builder

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

emiratesId?string

uaePassId?string

userId_IDS?string

mobileNumber*string

Length1 <= length

firstNameEN*string

Length3 <= length <= 30

firstNameAR?string

Length2 <= length <= 100

lastNameEN*string

Length3 <= length <= 30

lastNameAR?string

Length2 <= length <= 100

nationalityEN?string

Match^[A-Z]+[a-zA-Z"'\s-]*$

Length0 <= length <= 50

nationalityAR?string

Length0 <= length <= 50

birthDate?string

Formatdate

language?Language

Value in

"English"
"Arabic"

email*string

Formatemail

Length1 <= length

userType?string

gender?Gender

Value in

"Female"
"Male"
"Unknown"

preferredLanguage?string

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/Account" \  -H "Content-Type: application/json" \  -d '{    "mobileNumber": "string",    "firstNameEN": "string",    "lastNameEN": "string",    "email": "[email protected]"  }'

{  "message": "string",  "payload": {    "emiratesId": "string",    "uaePassId": "string",    "mobileNumber": "string",    "firstNameEN": "string",    "firstNameAR": "string",    "lastNameEN": "string",    "lastNameAR": "string",    "nationalityEN": "string",    "nationalityAR": "string",    "birthDate": "2019-08-24T14:15:22Z",    "language": "English",    "email": "string",    "userType": "string",    "gender": "Female",    "preferredLanguage": "string"  },  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

200application/json

400application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`