Update Customer

Updates a customer, if the requesting manager has access permissions to it.

PATCH /api/v1/customers/{id}/

Example request body

Data Example (JSON)
{
    "first_name": "Toni"
}

Example successful response (200)

Response (200)
{
    "id": 4165,
    "total_orders": 0,
    "total_licenses": 0,
    "labels": [],
    "customer_account": null,
    "email": "[email protected]",
    "first_name": "Toni",
    "last_name": "Potter",
    "company_name": "Hogwarts",
    "phone": "+385913111111",
    "reference": "ref123",
    "address": "Street 1",
    "postcode": "10000",
    "city": "New York",
    "country": "US",
    "state": "NY",
    "clabels_all": null,
    "cognito_user_pool_id": "",
    "metadata": {},
    "company": 277,
    "license_user": null,
    "clabels": []
}

Body parameters

Name
Type
Required
Description

email

string

optional

email

first_name

string

optional

first_name

last_name

string

optional

last_name

company_name

string

optional

company_name

phone

string

optional

phone

reference

string

optional

reference

address

string

optional

address

postcode

string

optional

postcode

city

string

optional

city

country

string

optional

country

state

string

optional

state

customer_account

integer

optional

integer

metadata

object

optional

JSON Object

Notes:

  • The endpoint requires the customer ID in the path ({id}).

  • Only fields provided in the PATCH body will be updated.

Was this helpful?