PATCH api/v2/customers/byid/{id}


Updates the specified customer by setting the values of the parameters passed.
Any parameters not provided will be left unchanged.

The following parameters do not allow blanks:
Email, Firstname, LastName, StreetName, Zipcode,
City, InvoiceFirstName, InvoiceLastName, InvoiceStreetName, InvoiceZipcode, InvoiceCity.

If successful update http status code 200 (Ok) is returned.
If customer not found, http status code 404 (NotFound) is returned.
If unsuccessful update http status code 400 (BadRequest) is returned.
if a server error occurs, http status code 500 (InternalServerError) is returned. the response body contains more details.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

F8 application customer id

globally unique identifier

Required

Body Parameters

Object with customer properties

UpdateCustomer
NameDescriptionTypeAdditional information
Firstname

string

If omitted (null) then not required

String length: between 0 and 50

Lastname

string

If omitted (null) then not required

String length: between 0 and 50

Phone

string

String length: between 0 and 20

Mobile

string

String length: between 0 and 20

Email

string

If omitted (null) then not required

String length: between 0 and 100

Valid email address format

StreetName

string

If omitted (null) then not required

String length: between 0 and 50

StreetNumber

string

String length: between 0 and 10

ApartmentNumber

string

String length: between 0 and 50

Zipcode

string

If omitted (null) then not required

Matching regular expression pattern: \d{5}

String length: between 5 and 5

City

string

If omitted (null) then not required

String length: between 0 and 50

CoAddress

string

String length: between 0 and 100

InvoiceFirstName

string

If omitted (null) then not required

String length: between 0 and 50

InvoiceLastName

string

If omitted (null) then not required

String length: between 0 and 50

InvoiceStreetName

string

If omitted (null) then not required

String length: between 0 and 50

InvoiceStreetNumber

string

String length: between 0 and 10

InvoiceApartmentNumber

string

String length: between 0 and 50

InvoiceZipcode

string

If omitted (null) then not required

Matching regular expression pattern: \d{5}

String length: between 5 and 5

InvoiceCity

string

If omitted (null) then not required

String length: between 0 and 50

Request Formats

application/json, text/json

Sample:
{
  "Firstname": "sample string 1",
  "Lastname": "sample string 2",
  "Phone": "sample string 3",
  "Mobile": "sample string 4",
  "Email": "sample string 5",
  "StreetName": "sample string 6",
  "StreetNumber": "sample string 7",
  "ApartmentNumber": "sample string 8",
  "Zipcode": "sample string 9",
  "City": "sample string 10",
  "CoAddress": "sample string 11",
  "InvoiceFirstName": "sample string 12",
  "InvoiceLastName": "sample string 13",
  "InvoiceStreetName": "sample string 14",
  "InvoiceStreetNumber": "sample string 15",
  "InvoiceApartmentNumber": "sample string 16",
  "InvoiceZipcode": "sample string 17",
  "InvoiceCity": "sample string 18"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

WebApiV2ResponseMessage
NameDescriptionTypeAdditional information
code

string

None.

message

string

None.

detail

string

None.

Response Formats

application/json, text/json

Sample:
{
  "code": "sample string 1",
  "message": "sample string 2",
  "detail": "sample string 3"
}