Customers & catalog · Clients
Update client
Changes the fields you send and leaves the others as they are. Every field is optional. A deleted client, or one that isn't yours, returns 404.
Send JSON, or multipart/form-data to replace the profile_image (JPEG, PNG or WebP, up to 10 MB). tags replaces the client's tags with an array of { "name", "slug" } objects and needs a JSON body.
Authorization
HeaderSend Authorization: Bearer <accessToken>, the token from Create token.
Path parameters
id string Required
The client's id.Body parameters
name string
The client's name.email string
The client's email address. Another of your clients already using it returns 409.phone string
The client's phone number.company string
The client's company name.status enum
ACTIVE, INACTIVE, DRAFT or PENDING.country string
Country name or ISO code.addressLine1 string
Street address, up to 200 characters.addressLine2 string
Apartment, suite or floor, up to 200 characters.city string
City, up to 100 characters.state string
State, province or region, up to 100 characters.postalCode string
ZIP or postal code, up to 20 characters.note string
Your internal note about the client.role string
A label for the client, e.g. buyer.