UpdateClientRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-schema/public-api-v6-update-client-request-schema.json",
  "title": "UpdateClientRequest",
  "description": "Implementation of the 'UpdateClientRequest' model.",
  "type": "object",
  "properties": {
    "Client": {
      "$ref": "#/components/schemas/ClientWithSuspensionInfo",
      "description": "Contains information about the client to be updated. The client ID is used to look up the existing client to update and any specified values are updated."
    },
    "Test": {
      "type": "boolean",
      "description": "When `true`, indicates that test mode is enabled. The method is validated, but no client data is added or updated.<br /> Default: **false**",
      "example": true
    },
    "CrossRegionalUpdate": {
      "type": "boolean",
      "description": "When `true`, the updated information is propagated to all of the region\u2019s sites where the client has a profile.<br /> When `false`, only the local client is updated.<br /> Default: **true**<br /> Important: The fields below will automatically propagate cross-regionally when updated through the UpdateClient endpoint, regardless the CrossRegionalUpdate parameter is set to `true` or `false`. * `RSSID` * `Prefix` * `Name (First, Middle, Last, Nickname)` * `Email` * `Birthday` * `Phone (Home, Mobile,",
      "example": true
    },
    "NewId": {
      "type": "string",
      "description": "The new RSSID to be used for the client. Use `NewId` to assign a specific number to be a client\u2019s ID. If that number is not available, the call returns an error. This RSSID must be unique within the subscriber\u2019s site. If this is a cross-regional update, the RSSID must be unique across the region. If the requested number is already in use, an error is returned. Note: NewId value cannot fall within the reserved default ID range (100000000 -&gt; 101000000)",
      "example": "example-value"
    },
    "LeadChannelId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the Lead Channel ID from lead management. If this is supplied then it will map lead channel on the lead management. If this is not supplied then it will have Publicapi LeadChannelId. This parameters required to track the lead channel if new client added to the location.",
      "example": 123456
    }
  }
}