Update a customer

Any signed in user. Patches a customer’s name, phone, national id, notes, or credit fields. An empty patch is refused with 400 and an unknown customer with 404; money stays strings.

PUT/api/v1/customers/{customerId}

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Path parameters

customerIdstringrequired

The customer id.

Request body

requiredapplication/json

namestring | null

phonestring | null

national_idstring | null

notesstring | null

credit_limitnumber | null

Show properties

Any of:

number

number

null

null

is_credit_allowedboolean | null

Responses

200

Customer updated

idstringrequired

namestringrequired

phonestringrequired

national_idstringrequired

notesstringrequired

image_urlstringrequired

credit_limitstringrequired

current_balancestringrequired

is_credit_allowedbooleanrequired

created_atstringrequired

updated_atstringrequired

is_deletedbooleanrequired

400

No fields to update, or a field fails validation

detailstringrequired

401

Not authenticated

detailstringrequired

404

Customer not found

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

customerIdpath*The customer id.

Bodyapplication/json

namestringphonestringnational_idstringnotesstringcredit_limitstringis_credit_allowedboolean

Request

curl -X PUT 'http://localhost:8000/api/v1/customers/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "phone": "string",
  "national_id": "string",
  "notes": "string",
  "credit_limit": 0,
  "is_credit_allowed": true
}'

const response = await fetch("http://localhost:8000/api/v1/customers/string", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"phone\": \"string\",\n  \"national_id\": \"string\",\n  \"notes\": \"string\",\n  \"credit_limit\": 0,\n  \"is_credit_allowed\": true\n}"
});

import requests

response = requests.put(
    "http://localhost:8000/api/v1/customers/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"phone\": \"string\",\n  \"national_id\": \"string\",\n  \"notes\": \"string\",\n  \"credit_limit\": 0,\n  \"is_credit_allowed\": true\n}",
)

Response

{
  "id": "string",
  "name": "string",
  "phone": "string",
  "national_id": "string",
  "notes": "string",
  "image_url": "string",
  "credit_limit": "string",
  "current_balance": "string",
  "is_credit_allowed": true,
  "created_at": "string",
  "updated_at": "string",
  "is_deleted": true
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}