customers_create
Create new customer records in ServiceTitan, including details like address, contacts, custom fields, and tags, to manage client information effectively.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| address | No | Customer address | |
| balance | No | Customer balance | |
| contacts | No | Customer contacts | |
| customFields | No | Custom fields | |
| doNotMail | No | Do not mail flag | |
| doNotService | No | Do not service flag | |
| externalData | No | External data | |
| locations | No | Customer locations | |
| name | Yes | Customer name | |
| tagTypeIds | No | Tag type IDs | |
| tenant | Yes | Format - int64. Tenant ID | |
| type | No | Customer type |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"address": {
"additionalProperties": false,
"description": "Customer address",
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
},
"unit": {
"type": "string"
},
"zip": {
"type": "string"
}
},
"type": "object"
},
"balance": {
"description": "Customer balance",
"type": "number"
},
"contacts": {
"description": "Customer contacts",
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"memo": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"customFields": {
"description": "Custom fields",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"typeId": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"doNotMail": {
"description": "Do not mail flag",
"type": "boolean"
},
"doNotService": {
"description": "Do not service flag",
"type": "boolean"
},
"externalData": {
"description": "External data",
"items": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"locations": {
"description": "Customer locations",
"items": {
"additionalProperties": false,
"properties": {
"active": {
"type": "boolean"
},
"address": {
"additionalProperties": false,
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
},
"unit": {
"type": "string"
},
"zip": {
"type": "string"
}
},
"type": "object"
},
"contacts": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"memo": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"customFields": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"typeId": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"customerId": {
"type": "integer"
},
"externalData": {
"items": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"tagTypeIds": {
"items": {
"type": "integer"
},
"type": "array"
},
"taxZoneId": {
"type": "integer"
},
"zoneId": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"name": {
"description": "Customer name",
"type": "string"
},
"tagTypeIds": {
"description": "Tag type IDs",
"items": {
"type": "integer"
},
"type": "array"
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
},
"type": {
"description": "Customer type",
"type": "string"
}
},
"required": [
"tenant",
"name"
],
"type": "object"
}