Update a customer

put

https://api.spirii.com/v2/customers/{id}

Updates a customer record in the system.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

number

required

Body Params

The customer data to update.

name

string

length ≤ 80

The complete name of the customer.

externalId

string | null

This field can be used as a reference to your own system, e.g. an internal customer number.

country

string | null

The country of the billing address.

contactDetails

object | null

The contact details of the person who can be contacted regarding any concerns about this customer.

payoutInformation

object | null

The payout information of the customer. It's important to pass this information if you use Spirii financial services. This ensures correct invoicing.

billingDetails

object | null

The billing details of the customer. It's important to pass this information if you use Spirii financial services.

financialSetup

object | null

This financial setup ensures the customer receives accurate invoices in the correct language and currency, and on time.

billingSettings

object | null

The billing settings of the customer.

receiptSettings

object | null

The receipt settings of the customer.

isTaxableDealer

boolean

Defaults to false

Whether the customer is registered as a taxable dealer. Used for tax handling. Manageable by Spirii admins only.

ownerId

number

Responses

400

Bad Request. An explanation message will be provided.

401

Unauthorized. The requested operation cannot be performed with the current access permissions.

403

Forbidden. Your credentials are missing or not valid. An explanation message will be provided.

404

The customer to be updated was not found.

500

An unexpected error occurred on the server while processing the request.

502

The request failed due to an error in an upstream service.

Language

Credentials

Header

Loading…

Response

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

application/json

202