PUT api/CUSTOMERS/{id}?foreigns={foreigns}

Update a single CUSTOMERS record

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Obligatory. The CUSTOMER_ID value of the record passed that need to be updated	integer	Required
foreigns	Optional. Default value is false. True=> Include nested foreign objects within reply. False=> Do NOT Include nested foreign objects within reply	boolean	Default value is False

Body Parameters

Obligatory. The new updated CUSTOMERS object that need to be updated

CUSTOMERS

Name	Type	Additional information
CUSTOMER_ID	integer	None.
CUSTOMER_ID_IMAGE	globally unique identifier	None.
CUSTOMER_NAME_AR	string	None.
CUSTOMER_NAME_EN	string	Required String length: inclusive between 0 and 400
FK_EMIRATE	integer	None.
EMAIL	string	Required String length: inclusive between 0 and 100
MOBILE_NO	string	Required String length: inclusive between 0 and 50
LOGIN_PASSWORD	string	Required String length: inclusive between 0 and 100
FK_MOBILE_COUNTRY	integer	None.
ACTIVE	boolean	None.
NOTES	string	String length: inclusive between 0 and 500
LAST_NOTIFY_DELETE	date	None.
FK_USER	integer	None.
FK_GROUP	integer	None.
COUNTRIES	COUNTRIES	None.
EMIRATES	EMIRATES	None.

Request Formats

application/json, text/json

Sample:

{
  "CUSTOMER_ID": 1,
  "CUSTOMER_ID_IMAGE": "3d1c78d4-e4e9-48ae-8cd8-7077649b294f",
  "CUSTOMER_NAME_AR": "sample string 2",
  "CUSTOMER_NAME_EN": "sample string 3",
  "FK_EMIRATE": 1,
  "EMAIL": "sample string 4",
  "MOBILE_NO": "sample string 5",
  "LOGIN_PASSWORD": "sample string 6",
  "FK_MOBILE_COUNTRY": 7,
  "ACTIVE": true,
  "NOTES": "sample string 9",
  "LAST_NOTIFY_DELETE": "2025-12-08T00:33:50.997Z",
  "FK_USER": 1,
  "FK_GROUP": 1,
  "COUNTRIES": {
    "COUNTRY_ID": 1,
    "COUNTRY_NO": 2,
    "CALLING_CODE": "sample string 3",
    "COUNTRY_NAME_AR": "sample string 4",
    "COUNTRY_NAME_EN": "sample string 5",
    "COUNTRY_CODE2": "sample string 6",
    "COUNTRY_CODE3": "sample string 7"
  },
  "EMIRATES": {
    "EMIRATE_ID": 1,
    "EMIRATE_NAME_AR": "sample string 2",
    "EMIRATE_NAME_EN": "sample string 3"
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CUSTOMERS_CMD_RESPONSE

Name	Description	Type	Additional information
Status		Status	None.
DATA		Collection of CUSTOMERS	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": {
    "Success": true,
    "MessageEn": "sample string 2",
    "MessageAr": "sample string 3",
    "DetailedMessage": "sample string 4",
    "Code": 0,
    "CartErrors": [
      {
        "ResultStatusCode": 0,
        "CartId": 1,
        "CorrectValue": {},
        "MessageEn": "sample string 2",
        "MessageAr": "sample string 3",
        "CartCorrectAction": 0
      },
      {
        "ResultStatusCode": 0,
        "CartId": 1,
        "CorrectValue": {},
        "MessageEn": "sample string 2",
        "MessageAr": "sample string 3",
        "CartCorrectAction": 0
      }
    ]
  },
  "DATA": [
    {
      "CUSTOMER_ID": 1,
      "CUSTOMER_ID_IMAGE": "bbd2e5cb-4849-478f-b1e9-4c22d49a5f9f",
      "CUSTOMER_NAME_AR": "sample string 2",
      "CUSTOMER_NAME_EN": "sample string 3",
      "FK_EMIRATE": 1,
      "EMAIL": "sample string 4",
      "MOBILE_NO": "sample string 5",
      "LOGIN_PASSWORD": "sample string 6",
      "FK_MOBILE_COUNTRY": 7,
      "ACTIVE": true,
      "NOTES": "sample string 9",
      "LAST_NOTIFY_DELETE": "2025-12-08T00:33:50.997Z",
      "FK_USER": 1,
      "FK_GROUP": 1,
      "COUNTRIES": {
        "COUNTRY_ID": 1,
        "COUNTRY_NO": 2,
        "CALLING_CODE": "sample string 3",
        "COUNTRY_NAME_AR": "sample string 4",
        "COUNTRY_NAME_EN": "sample string 5",
        "COUNTRY_CODE2": "sample string 6",
        "COUNTRY_CODE3": "sample string 7"
      },
      "EMIRATES": {
        "EMIRATE_ID": 1,
        "EMIRATE_NAME_AR": "sample string 2",
        "EMIRATE_NAME_EN": "sample string 3"
      }
    },
    {
      "CUSTOMER_ID": 1,
      "CUSTOMER_ID_IMAGE": "bbd2e5cb-4849-478f-b1e9-4c22d49a5f9f",
      "CUSTOMER_NAME_AR": "sample string 2",
      "CUSTOMER_NAME_EN": "sample string 3",
      "FK_EMIRATE": 1,
      "EMAIL": "sample string 4",
      "MOBILE_NO": "sample string 5",
      "LOGIN_PASSWORD": "sample string 6",
      "FK_MOBILE_COUNTRY": 7,
      "ACTIVE": true,
      "NOTES": "sample string 9",
      "LAST_NOTIFY_DELETE": "2025-12-08T00:33:50.997Z",
      "FK_USER": 1,
      "FK_GROUP": 1,
      "COUNTRIES": {
        "COUNTRY_ID": 1,
        "COUNTRY_NO": 2,
        "CALLING_CODE": "sample string 3",
        "COUNTRY_NAME_AR": "sample string 4",
        "COUNTRY_NAME_EN": "sample string 5",
        "COUNTRY_CODE2": "sample string 6",
        "COUNTRY_CODE3": "sample string 7"
      },
      "EMIRATES": {
        "EMIRATE_ID": 1,
        "EMIRATE_NAME_AR": "sample string 2",
        "EMIRATE_NAME_EN": "sample string 3"
      }
    }
  ]
}