Update an existing customer

This action will update an existing customer matching the given ID.

Try this request in your browser

/api/ /customers/update

Headers

X-Auth-App
X-Auth-Token
X-Auth-Secret
X-Auth-Extension
X-Auth-Password
X-Proxy-Auth-Token
X-Proxy-Auth-Secret

Parameters

id String
name String
invoice_reference String
line1 String
line2 String
line3 String
line4 String
postcode String
vat_number String
vat_rate Decimal
auto_payments Boolean

Structures

Include expansions?

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/customers/update

Access

Must be authenticated as an admin or reseller. If not authorised, a MustBeAnAdminOrReseller error will be returned.

Parameters

Parameter Type Default

id Required

The ID of the customer

String null

name

The name of the customer

String null

invoice_reference

The customer's invoice reference

String null

line1

The first line of the customer's address

String null

line2

The second line of the customer's address

String null

line3

The third line of the customer's address

String null

line4

The fourth line of the customer's address

String null

postcode

The customer's postcode

String null

vat_number

The customer's VAT number

String null

vat_rate

The VAT rate applied to this customer

Decimal null

auto_payments

Whether payments are automatically collected for this customer

Boolean null

Errors

Error Attributes

ValidationError

A validation error occurred

  • errors

    An array of errors

Response Data

This action will return a customer structure.

You will only receive basic data for this structure, no extended data is available. By default, you'll receive all expansions for the structure. You remove any/all of them by providing an array of new expansion names in the _expansions parameter on the request.