[lightMode]

Update Customer

PUT/customers/{customer}

[updatedIn] 8 days ago

This endpoint allows you to update customer details by passing the customer as a path parameter.

:::tip[Note]
The existing values of all skipped parameters will remain unchanged.
:::

`customers.read_write`- Customers Read & Write

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

[message.pathParameter]

customer

integer

required

The Customer ID. List of Customers ID can be found here.

first_name

string

optional

Customer given name.

Example:

User

last_name

string

optional

Customer family name.

Example:

name

mobile

string

optional

The numerical contact information belonging to a customer that allows communication via telephone, without country code.

Example:

555555555

mobile_code_country

string

optional

The numeric prefix indicating a customer's country for mobile communication.

Example:

+966

string

optional

Email address of the customer used for electronic communication.

Example:

[email protected]

gender

enum<string>

optional

The categorization of an individual as male, female, based on their biologically determined characteristics.

Allowed values:

malefemale

Example:

male

birthday

string

optional

The customer date of brith.

Example:

1950-10-20

Match pattern:

YYYY-MM-DD

groups

array[integer]

optional

A unique identifier for a group to which a customer belongs.

{
  "first_name": "Ahmed",
  "last_name": "Ali",
  "email": "[email protected]",
  "gender": "female",
  "birthday": "1997-06-03"
}

Request samples

[api.label.responses]

Success(200)

Not Found(404)

Error Validation(422)

HTTP Code: 200

Content Type : JSONapplication/json

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object (Customer)

optional

Detailed structure of the customer model object showing its fields and data types.

number

required

A unique identifier for the customer.

first_name

string

required

The customer's first name.

<= 25 characters

last_name

string

required

The customer's last name.

<= 25 characters

mobile

number

required

The customer's mobile phone number without the country code.

mobile_code

string

required

The country code for the customer's mobile phone number.

string <email>

required

The customer's email address.

urls

object (Urls)

required

A list of URLs associated with the customer, such as their website or social media profiles.

avatar

string

required

A URL to the customer's avatar image.

gender

enum<string>

required

The customer's gender.

Allowed values:

malefemale

birthday

object

required

city

string

required

The city where the customer lives.

country

string

required

The country where the customer lives.

country_code

string

required

The country code for the customer's country.

currency

string

required

The currency that the customer uses.

location

string

required

The customer's location, represented as a string.

updated_at

object (Date)

required

The date and time when the customer's information was last updated.

groups

array[integer]

required

A list of group IDs that the customer belongs to.

{
  "status": 200,
  "success": true,
  "data": {
    "id": 2075683582,
    "first_name": "Ahmed",
    "last_name": "Ali",
    "mobile": 560716138,
    "mobile_code": "999",
    "email": "[email protected]",
    "urls": {
      "customer": "https://shtara.com/profile",
      "admin": "https://shtara.com/profiley"
    },
    "avatar": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
    "gender": "male",
    "city": "Riyadh",
    "country": "السعودية",
    "location": "null",
    "updated_at": {
      "date": "2020-04-02 22:43:26.000000",
      "timezone_type": 3,
      "timezone": "Asia/Riyadh"
    },
    "groups": [
      11323141,
      11323142
    ]
  }
}

[updatedIn] 8 days ago