customers_update
Update customer information in ServiceTitan, including active status, name, address, custom fields, balance, and preferences like do-not-mail or do-not-service flags.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| active | No | Whether the customer is active | |
| address | No | The address of the customer | |
| balance | No | The balance of the customer | |
| customFields | No | The custom fields of the customer | |
| doNotMail | No | Whether the customer should not be mailed | |
| doNotService | No | Whether the customer should not be serviced | |
| externalData | No | The external data of the customer | |
| id | Yes | Format - int64. | |
| mergedToId | No | The ID of the customer this customer was merged to | |
| name | No | The name of the customer | |
| tagTypeIds | No | The tag type IDs of the customer | |
| tenant | Yes | Format - int64. Tenant ID | |
| type | No | The type of the customer |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"active": {
"description": "Whether the customer is active",
"type": "boolean"
},
"address": {
"additionalProperties": false,
"description": "The address of the customer",
"properties": {
"city": {
"description": "The city",
"type": "string"
},
"country": {
"description": "The country",
"type": "string"
},
"latitude": {
"description": "The latitude",
"type": "number"
},
"longitude": {
"description": "The longitude",
"type": "number"
},
"state": {
"description": "The state",
"type": "string"
},
"street": {
"description": "The street address",
"type": "string"
},
"unit": {
"description": "The unit number",
"type": "string"
},
"zip": {
"description": "The zip code",
"type": "string"
}
},
"type": "object"
},
"balance": {
"description": "The balance of the customer",
"type": "number"
},
"customFields": {
"description": "The custom fields of the customer",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the custom field",
"type": "string"
},
"typeId": {
"description": "The type ID of the custom field",
"type": "integer"
},
"value": {
"description": "The value of the custom field",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"doNotMail": {
"description": "Whether the customer should not be mailed",
"type": "boolean"
},
"doNotService": {
"description": "Whether the customer should not be serviced",
"type": "boolean"
},
"externalData": {
"description": "The external data of the customer",
"items": {
"additionalProperties": false,
"properties": {
"key": {
"description": "The key of the external data",
"type": "string"
},
"value": {
"description": "The value of the external data",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"id": {
"description": "Format - int64.",
"type": "integer"
},
"mergedToId": {
"description": "The ID of the customer this customer was merged to",
"type": "integer"
},
"name": {
"description": "The name of the customer",
"type": "string"
},
"tagTypeIds": {
"description": "The tag type IDs of the customer",
"items": {
"type": "integer"
},
"type": "array"
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
},
"type": {
"description": "The type of the customer",
"type": "string"
}
},
"required": [
"id",
"tenant"
],
"type": "object"
}