---
updatedAt: 2025-05-21T09:37:30.000Z
agentTools:
  projectIndex: https://toursolver.readme.io/llms.txt
---

# Update clients

Use this service to update clients. These clients can then be used through the UI.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "servers": [
    {
      "url": "https://api.geoconcept.com/tsapi",
      "description": "Production",
      "variables": {}
    }
  ],
  "info": {
    "contact": {
      "email": "support@nomadia-group.com",
      "name": "Nomadia Group",
      "url": "https://www.nomadia-group.com/contact/"
    },
    "description": "Web APIs for TourSolver.",
    "title": "TourSolver API",
    "version": "2.0"
  },
  "tags": [
    {
      "description": "Manage your client base",
      "name": "Client"
    }
  ],
  "paths": {
    "/updateClients": {
      "put": {
        "description": "Use this service to update clients. These clients can then be used through the UI.",
        "operationId": "updateClients",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateClientsRequest"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/UpdateClientsRequest"
              }
            },
            "text/xml": {
              "schema": {
                "$ref": "#/components/schemas/UpdateClientsRequest"
              }
            }
          }
        },
        "responses": {
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateClientsResult"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateClientsResult"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateClientsResult"
                }
              }
            },
            "description": "result with status \"OK\", or status \"ERROR\" with more information\nin the \"message\" field, and the list of created clients (with\ngenerated externRef and internal id)"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ],
        "servers": [
          {
            "description": "Production",
            "url": "https://api.geoconcept.com/tsapi",
            "variables": {}
          }
        ],
        "summary": "Update clients",
        "tags": [
          "Client"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ClientEntity": {
        "type": "object",
        "properties": {
          "additionalAddress": {
            "type": "string"
          },
          "agency": {
            "type": "string"
          },
          "allSkillsRequired": {
            "type": "boolean"
          },
          "allowedDepots": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "color": {
            "type": "string"
          },
          "countryFull": {
            "type": "string"
          },
          "creationDate": {
            "type": "string",
            "format": "date-time"
          },
          "customData": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "description": {
            "type": "string"
          },
          "designation": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "externRef": {
            "type": "string"
          },
          "fixedVisitDuration": {
            "type": "integer",
            "format": "int32"
          },
          "frequency": {
            "type": "string"
          },
          "frequencyType": {
            "type": "string"
          },
          "geocodeType": {
            "type": "string"
          },
          "getNotification": {
            "type": "boolean"
          },
          "givenName": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "isCustomer": {
            "type": "boolean"
          },
          "lastComment": {
            "type": "string"
          },
          "lastFeedback": {
            "type": "integer",
            "format": "int32"
          },
          "lastUpdateUser": {
            "type": "string"
          },
          "lastVisitDate": {
            "type": "string",
            "format": "date-time"
          },
          "lastVisitId": {
            "type": "string"
          },
          "manualPosition": {
            "$ref": "#/components/schemas/ManualPosition"
          },
          "maxSpacing": {
            "type": "integer",
            "format": "int32"
          },
          "minSpacing": {
            "type": "integer",
            "format": "int32"
          },
          "mobile": {
            "type": "string"
          },
          "nextVisitDate": {
            "type": "string",
            "format": "date-time"
          },
          "occupation": {
            "type": "string"
          },
          "ownerId": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "photoURL": {
            "type": "string"
          },
          "possibleVisitDays1": {
            "type": "string"
          },
          "possibleVisitDays2": {
            "type": "string"
          },
          "possibleVisitDays3": {
            "type": "string"
          },
          "possibleVisitDays4": {
            "type": "string"
          },
          "providedProducts": {
            "type": "string"
          },
          "quantities": {
            "type": "array",
            "items": {
              "type": "number",
              "format": "double"
            }
          },
          "requiredSkills": {
            "type": "string"
          },
          "sector": {
            "type": "string"
          },
          "startsBefore": {
            "type": "string"
          },
          "stateFull": {
            "type": "string"
          },
          "streetAndNumber": {
            "type": "string"
          },
          "surName": {
            "type": "string"
          },
          "timeWindowBeginTime1": {
            "type": "integer",
            "format": "int32"
          },
          "timeWindowBeginTime2": {
            "type": "integer",
            "format": "int32"
          },
          "timeWindowBeginTime3": {
            "type": "integer",
            "format": "int32"
          },
          "timeWindowBeginTime4": {
            "type": "integer",
            "format": "int32"
          },
          "timeWindowEndTime1": {
            "type": "integer",
            "format": "int32"
          },
          "timeWindowEndTime2": {
            "type": "integer",
            "format": "int32"
          },
          "timeWindowEndTime3": {
            "type": "integer",
            "format": "int32"
          },
          "timeWindowEndTime4": {
            "type": "integer",
            "format": "int32"
          },
          "title": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "updateDate": {
            "type": "string",
            "format": "date-time"
          },
          "useManualPositioning": {
            "type": "boolean"
          },
          "visitType": {
            "type": "integer",
            "format": "int32"
          },
          "wholeVisitInTimeWindow": {
            "type": "boolean"
          },
          "x": {
            "type": "number",
            "format": "double"
          },
          "y": {
            "type": "number",
            "format": "double"
          },
          "zipCode": {
            "type": "string"
          }
        }
      },
      "ManualPosition": {
        "type": "object",
        "properties": {
          "when": {
            "type": "string",
            "format": "date-time"
          },
          "who": {
            "type": "string"
          },
          "x": {
            "type": "number",
            "format": "double"
          },
          "y": {
            "type": "number",
            "format": "double"
          }
        }
      },
      "UpdateClientsRequest": {
        "type": "object",
        "properties": {
          "clients": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ClientEntity"
            }
          }
        }
      },
      "UpdateClientsResult": {
        "type": "object",
        "properties": {
          "errCode": {
            "type": "string",
            "description": "Error code",
            "enum": [
              "0",
              "1",
              "2",
              "3",
              "4",
              "5",
              "6",
              "7",
              "8",
              "9",
              "10",
              "11",
              "12",
              "13",
              "14",
              "100",
              "101",
              "102",
              "103",
              "104",
              "105",
              "106",
              "107",
              "108",
              "109",
              "110",
              "111",
              "112",
              "113",
              "114",
              "115",
              "116",
              "200",
              "201",
              "300",
              "301",
              "400",
              "401",
              "500",
              "501",
              "502",
              "600",
              "601",
              "602",
              "603",
              "604",
              "1000",
              "1001",
              "1002",
              "1003",
              "1004",
              "1006",
              "1007",
              "1008",
              "2000",
              "2001",
              "2002",
              "2003",
              "2004",
              "2005",
              "2006",
              "2007",
              "2008",
              "2009",
              "2010",
              "2011",
              "2021",
              "2022",
              "2023",
              "2024",
              "2025",
              "2026",
              "2027",
              "2028",
              "2029",
              "2030",
              "2031",
              "3000",
              "3001",
              "3002",
              "4000",
              "4001",
              "4002",
              "5000",
              "5001",
              "5002",
              "5003",
              "6000"
            ]
          },
          "message": {
            "type": "string",
            "description": "Error message"
          },
          "status": {
            "type": "string",
            "description": "OK or ERROR",
            "enum": [
              "OK",
              "ERROR"
            ]
          }
        }
      }
    },
    "securitySchemes": {
      "apiKey": {
        "description": "The api key can be passed through an header or in the query.",
        "in": "header",
        "name": "apiKey",
        "type": "apiKey"
      }
    }
  }
}
```