Customers

Update a customer

Partially updates a customer: only the fields you send change. An empty string clears companyName, email, phoneNumber and responsibleProfileId. address, when sent, must be complete and replaces the customer's primary address (or adds one). Unknown fields are rejected with 400. Responds with the stored customer.

patch/customers/{customerId}

Request

  • Base URL
    https://api3.autarc.energy/v1
  • Auth
    API key in header X-Api-Key

Path parameters

customerIdstring required

ID (or customer number, e.g. K-0001) of the customer to update

Request body

firstNamestring
lastNamestring
companyNamestring

Empty string clears it.

emailstring

Empty string clears it.

phoneNumberstring

Empty string clears it.

responsibleProfileIdstring

Team member (see GET /team-members) responsible for the customer. Must belong to your company; empty string clears it.

Response

OK

idstring uuid
firstNamestring
lastNamestring
companyIdstring uuid
humanIdstring nullable
createdAtstring date-time
updatedAtstring date-time
emailstring email nullable
invoiceEmailstring email nullable
phoneNumberstring nullable
isCompanyboolean
companyNamestring nullable
availability'morning' | 'afternoon' | 'evening' | 'weekend_only' | 'flexible'
descriptionstring nullable
websitestring uri nullable

Example response

{
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Suite 101",
    "postalCode": "12047",
    "city": "Berlin",
    "country": "Deutschland",
    "countryCode": "DE",
    "latitude": 48.6964906,
    "longitude": 13.2635728
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.