Customers & catalog · Clients
Create client
Adds a client to your account. If you already have a client with this email, that client is returned unchanged and the other fields are ignored.
Send JSON, or multipart/form-data to upload a profile_image (JPEG, PNG or WebP, up to 10 MB). tags is an array of { "name", "slug" } objects, e.g. [{ "name": "VIP", "slug": "vip" }], and needs a JSON body.
Authorization
HeaderSend Authorization: Bearer <accessToken>, the token from Create token.
Body parameters
name string Required
The client's name.email string Required
The client's email address.phone string Required
The client's phone number, e.g. +15551234567.company string
The client's company name.status enum
ACTIVE (default), INACTIVE, DRAFT or PENDING.country string
Country name or ISO code.addressLine1 string
Street address, up to 200 characters. Printed on invoices.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.