Change the supplied fields of one scout and keep the rest. This overwrites the supplied saved criteria and changes future marketplace checks and daily digests. vehicleIndex edits one saved vehicle, and vehicleCombinations replaces the full vehicle list. Filter objects change only the supplied includes or excludes. A stale expectedUpdatedAt returns a conflict and changes nothing.
View input schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Scout ID to update"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "New scout name"
},
"clearLocation": {
"type": "boolean",
"description": "Remove the saved location and radius. Cannot combine with a new ZIP or radius."
},
"vehicleCombinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"make": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"trims": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"startYear": {
"type": "integer",
"minimum": 1900,
"maximum": 2100
},
"endYear": {
"type": "integer",
"minimum": 1900,
"maximum": 2100
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 20,
"description": "Complete vehicle alternatives, using make, model, trims, startYear and endYear. Replaces the entire saved vehicle list. Cannot be combined with make/model/trims/yearMin/yearMax or vehicleIndex."
},
"make": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Vehicle make"
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Vehicle model"
},
"trims": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20,
"description": "Allowed trims, such as XLE. Empty array clears this filter."
},
"yearMin": {
"type": "integer",
"minimum": 1900,
"maximum": 2100,
"description": "Minimum model year"
},
"yearMax": {
"type": "integer",
"minimum": 1900,
"maximum": 2100,
"description": "Maximum model year"
},
"priceMin": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Minimum price in US dollars"
},
"priceMax": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Maximum price in US dollars"
},
"mileageMin": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Minimum mileage"
},
"mileageMax": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Maximum mileage"
},
"zipCode": {
"type": "string",
"pattern": "^\\d{5}$",
"description": "US ZIP code"
},
"maxDistanceMiles": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "Radius from the ZIP code, in miles"
},
"colors": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"pattern": "^[a-zA-Z0-9\\s-]+$"
},
"maxItems": 20
},
{
"type": "object",
"properties": {
"includes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"pattern": "^[a-zA-Z0-9\\s-]+$"
},
"maxItems": 20
},
"excludes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"pattern": "^[a-zA-Z0-9\\s-]+$"
},
"maxItems": 20
}
},
"additionalProperties": false
}
],
"description": "Exterior colors. {includes, excludes} replaces only the supplied sides. An empty array clears that side. A plain array replaces includes only. Omitted sides stay unchanged."
},
"interiorColors": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"pattern": "^[a-zA-Z0-9\\s-]+$"
},
"maxItems": 20
},
{
"type": "object",
"properties": {
"includes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"pattern": "^[a-zA-Z0-9\\s-]+$"
},
"maxItems": 20
},
"excludes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"pattern": "^[a-zA-Z0-9\\s-]+$"
},
"maxItems": 20
}
},
"additionalProperties": false
}
],
"description": "Interior colors. {includes, excludes} replaces only the supplied sides. An empty array clears that side. A plain array replaces includes only. Omitted sides stay unchanged."
},
"drivetrains": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
{
"type": "object",
"properties": {
"includes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"excludes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
}
},
"additionalProperties": false
}
],
"description": "Drivetrains. {includes, excludes} replaces only the supplied sides. An empty array clears that side. A plain array replaces includes only. Omitted sides stay unchanged."
},
"transmissions": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
{
"type": "object",
"properties": {
"includes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"excludes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
}
},
"additionalProperties": false
}
],
"description": "Transmissions. {includes, excludes} replaces only the supplied sides. An empty array clears that side. A plain array replaces includes only. Omitted sides stay unchanged."
},
"bodyStyles": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
{
"type": "object",
"properties": {
"includes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"excludes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
}
},
"additionalProperties": false
}
],
"description": "Body styles. {includes, excludes} replaces only the supplied sides. An empty array clears that side. A plain array replaces includes only. Omitted sides stay unchanged."
},
"fuelTypes": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
{
"type": "object",
"properties": {
"includes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"excludes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
}
},
"additionalProperties": false
}
],
"description": "Fuel types. {includes, excludes} replaces only the supplied sides. An empty array clears that side. A plain array replaces includes only. Omitted sides stay unchanged."
},
"features": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
{
"type": "object",
"properties": {
"includes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"excludes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
}
},
"additionalProperties": false
}
],
"description": "Features. {includes, excludes} replaces only the supplied sides. An empty array clears that side. A plain array replaces includes only. Omitted sides stay unchanged."
},
"keywords": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
{
"type": "object",
"properties": {
"includes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"excludes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
}
},
"additionalProperties": false
}
],
"description": "Listing keywords. {includes, excludes} replaces only the supplied sides. An empty array clears that side. A plain array replaces includes only. Omitted sides stay unchanged."
},
"vehicleIndex": {
"type": "integer",
"minimum": 0,
"maximum": 99,
"description": "Zero-based position in saved vehicleCombinations; required for a vehicle edit when more than one is saved"
},
"expectedUpdatedAt": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The scout's updatedAt value; the update is rejected if the scout changed since then"
}
},
"required": [
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}