Partially update a Customer

patch

https://vinoshipper.com/api/v3/p/customers/{customerId}

Changes only the properties sent. An omitted property keeps its stored value, and null clears it where the property allows. Nested objects and arrays replace the stored value whole. Send only the properties to change: a customer as returned by GET is rejected for its read-only properties.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

int32

required

Customer ID

Body Params

A partial update. Only the properties sent are changed; nested objects and arrays replace the stored value whole. An unknown property is rejected.

salutation

string | null

The customer's salutation. Omit to leave unchanged. Send null to clear it. An empty string also clears it.

firstName

string

The customer's first name. Omit to leave unchanged. It can't be cleared, so null is rejected.

lastName

string

The customer's last name. Omit to leave unchanged. It can't be cleared, so null is rejected.

company

string | null

The customer's company. Omit to leave unchanged. Send null to clear it. A wholesale customer always keeps a company, so null leaves theirs unchanged.

dateOfBirth

object

string

The customer's email address. Omit to leave unchanged. It can't be cleared, so null is rejected.

phone

object | null

alternatePhones

array of objects | null

Alternate phone numbers; an array replaces the stored list. Omit to leave unchanged. Send null to clear it.

alternatePhones

memberNumber

string | null

The producer's identifier for this customer. Omit to leave unchanged. Send null to clear it. An empty string also clears it.

enrolledById

int32 | null

The team member ID of the person that enrolled this customer. Omit to leave unchanged. Send null to clear it.

optedIntoMarketingEmails

boolean

Customer's email marketing preference. Omit to leave unchanged. It can't be cleared, so null is rejected. Has no effect once the customer has unsubscribed. You are responsible for ensuring proper consent has been collected.

optedIntoMarketingSms

boolean

Customer's SMS marketing preference. Omit to leave unchanged. It can't be cleared, so null is rejected. Only false takes effect: SMS consent regulations don't allow opting a customer in via API.

address

object | null

The address of the location where the sale is made

customerSince

date

The date the customer profile was created. Omit to leave unchanged. It can't be cleared, so null is rejected.

ageVerifiedBy

object

The Vinoshipper team member information

wholesaleType

string | null

enum

The wholesale customer type. Not allowed for non-wholesale customers. A wholesale customer always keeps a type, so null leaves theirs unchanged.

Allowed:

Responses

401

Authentication failed

403

Insufficient permission

404

Not Found

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Operation successful

400Request has failed validation

500Internal server error