GEgetmaintainx
Customers

Update customer

Changed on
patch/customers/{id}

Request

  • Base URL
    https://api.getmaintainx.com/v1
  • Auth
    HTTP bearer

Path parameters

idinteger required

ID of the customer

Headers

x-organization-idinteger

Required if using a multi organizations token

Request body

namestring

Name of the customer

descriptionstring nullable

Description of the customer

extraFieldsobject

Customer custom fields, keyed by field label

Example request

{
  "name": "Acme Manufacturing",
  "description": "Primary service customer",
  "extraFields": {
    "external_id": "QBO-42"
  }
}

Response

Successfully updated customer

Example response

{
  "customer": {
    "id": 123456,
    "name": "Acme Manufacturing",
    "description": "Primary service customer",
    "archivedAt": "2025-01-22T15:30:00.000Z",
    "createdAt": "2025-01-22T15:30:00.000Z",
    "updatedAt": "2025-01-22T15:30:00.000Z",
    "extraFields": {
      "external_id": "QBO-42"
    }
  }
}

Changes