Customers

Create customer

Changed on
post/customers

Request

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

Headers

x-organization-idinteger

Required if using a multi organizations token

Request body

namestring required

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 created customer

idinteger required

Global ID of the customer

Example response

{
  "id": 123456
}

Changes