Update a customer (company or individual)

put

https://app.pennylane.com/api/external/v2/customers/{id}

This endpoint updates a customer. Only the fields provided in the
request body are updated. The customer type can be changed by providing the
customer_type field.

Some fields are exclusive to one customer type. Sending a field that does
not belong to the current customer type returns a 422.

Company-exclusive: name, vat_number, reg_no
Individual-exclusive: first_name, last_name

When changing customer_type, some fields of the previous type are cleared automatically.
See each field's description for details.

ℹ️
This endpoint requires the following scope: customers:all

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Customer identifier

Body Params

customer_type

string

enum

The type of the customer. Changing this value clears the fields of the previous type automatically.

Allowed:

name

string

Company customers only. Sending this field for an individual customer returns a 422.

first_name

string

length ≤ 1000

Individual customers only. Sending this field for a company customer returns a 422. Existing value cleared automatically when switching to company.

last_name

string

length ≤ 1000

Individual customers only. Sending this field for a company customer returns a 422. Existing value cleared automatically when switching to company.

vat_number

string

Company customers only. Sending this field for an individual customer returns a 422. Existing value cleared automatically when switching to individual.

reg_no

string

Company customers only. Sending this field for an individual customer returns a 422. Existing value cleared automatically when switching to individual.

phone

string

billing_address

object

delivery_address

object

payment_conditions

string

enum

Note that the custom option is only used on Pennylane's web app to avoid pre-filling the deadline when creating an invoice. On the API it has no effect and you will still have to provide a deadline when creating an invoice.

billing_iban

string | null

recipient

string

The name of the person to whom the invoice is addressed

reference

string | null

notes

string | null

emails

array of strings

emails

external_reference

string

billing_language

string

enum

The language in which the customer will receive invoices. Default is fr_FR

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

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

application/json

200Returns the updated customer

400Bad request

401Access token is missing or invalid

403Access to this resource forbidden

404The resource was not found

422Unprocessable content