PATCH v3/customers/{id}

Update the details on a customers record

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required

Body Parameters

CustomerPatch

Name	Type	Additional information
Email	string	None.
FirstName	string	None.
LastName	string	None.
Mobile	string	None.
Phone	string	None.
Title	string	None.
GiftAidConfirmed	boolean	None.
BirthDate	date	None.
Attributes	There will be additional properties (custom to each client) with the prefix 'Attribute_'	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json

Sample:

{
  "email": "sample string 1",
  "firstName": "sample string 3",
  "lastName": "sample string 5",
  "mobile": "sample string 7",
  "phone": "sample string 9",
  "title": "sample string 11",
  "giftAidConfirmed": true,
  "birthDate": "2024-11-22T12:10:31.6212548+00:00"
}

text/xml

Sample:

The response/request for text/xml format is no longer supported for this endpoint.

Response Information

Resource Description

Customer

Name	Type	Additional information
Age	integer	None.
AllStatements	Collection of DataProtectionStatement	None.
AgreedStatements	Collection of DataProtectionStatement	None.
Addresses	Collection of CustomerAddress	None.
BillingAddress	CustomerAddress	None.
DeliveryAddress	CustomerAddress	None.
BirthDate	date	None.
Email	string	None.
FirstName	string	None.
LastName	string	None.
Mobile	string	None.
Name	string	None.
Phone	string	None.
AllTagsByGroup	Collection of CustomerTagGroup	None.
TagsByGroup	Collection of TagGroup	None.
Tags	Collection of Tag	None.
AllTags	Collection of CustomerTag	None.
PrintAtHomeDocuments	Collection of PrintAtHomeDocument	None.
Title	string	None.
PasswordSet	boolean	None.
GiftAidDeclarationRequired	boolean	None.
TicketSubscriptions	Collection of CustomerInventoryTicketSubscription	None.
Subscriptions	Collection of CustomerSubscription	None.
Orders	Collection of Order	None.
StoredCards	Collection of StoredCard	None.
Id	string	None.
Attributes	There will be additional properties (custom to each client) with the prefix 'Attribute_'	None.
CreditBalance	Money	None.

Response Formats

application/json, text/xml

Sample:

Sample not available.