Skip to main content
All endpoints require an Authorization: Bearer <token> header.

​
Endpoint

PUT /api/customers/:id

​
Path parameters

​
id
string
required
UUID of the customer to update.

​
Request body

All fields are optional. Only provided fields will be updated.
​
name
string
Full name of the customer.
​
email
string
Email address of the customer.
​
phone
string
Phone number of the customer.
​
address
string
Mailing address of the customer.

​
Response

Returns the updated customer object.
​
id
string
required
Unique identifier for the customer (UUID).
​
name
string
required
Full name of the customer.
​
email
string
required
Email address of the customer.
​
phone
string
Phone number of the customer. null if not set.
​
address
string
Mailing address of the customer. null if not set.
​
tenantId
string
required
UUID of the tenant this customer belongs to.
​
createdAt
string
required
ISO 8601 timestamp of when the customer was created.
​
updatedAt
string
required
ISO 8601 timestamp of when the customer was last updated.

​
Examples

curl --request PUT \
  --url http://localhost:5000/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "phone": "+1-555-0199",
    "address": "456 Oak Ave, Springfield, IL 62702"
  }'

​
Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Acme Corp",
  "email": "billing@acme.com",
  "phone": "+1-555-0199",
  "address": "456 Oak Ave, Springfield, IL 62702",
  "tenantId": "f0e1d2c3-b4a5-6789-cdef-012345678901",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-03-20T09:45:00.000Z"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us