{
  "$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-add-client-request-schema.json",
  "title": "AddClientRequest",
  "description": "Implementation of the 'AddClientRequest' model.",
  "type": "object",
  "properties": {
    "FirstName": {
      "type": "string",
      "description": "The client\u2019s first name. You must specify a first name when you add a client.",
      "example": "Alex"
    },
    "LastName": {
      "type": "string",
      "description": "The client\u2019s last name. You must specify a last name when you add a client.",
      "example": "Lane"
    },
    "AccountBalance": {
      "type": "number",
      "format": "double",
      "description": "The client\u2019s current [account balance](https://mindbody-online-support.force.com/support/s/articl e/203262013-Adding-account-payments-video-tutorial?language=en_US).",
      "example": 49.99
    },
    "Action": {
      "$ref": "#/components/schemas/Action1Enum",
      "description": "The action taken."
    },
    "Active": {
      "type": "boolean",
      "description": "When `true`, indicates that the client is active at the site.<br /> When `false`, indicates that the client is not active at the site.",
      "example": true
    },
    "AddressLine1": {
      "type": "string",
      "description": "The first line of the client\u2019s street address.",
      "example": "123 Market St"
    },
    "AddressLine2": {
      "type": "string",
      "description": "The second line of the client\u2019s street address, if needed.",
      "example": "123 Market St"
    },
    "ApptGenderPrefMale": {
      "type": "boolean",
      "description": "When `true`, indicates that the client prefers services to be provided by a male service provider.<br /> When `false`, indicates that the client prefers services to be provided by a female service provider.<br /> When `null`, indicates that the client has no preference. Default: **null**",
      "example": true
    },
    "BirthDate": {
      "type": "string",
      "format": "date-time",
      "description": "The client\u2019s date of birth.",
      "example": "2026-05-28T14:30:00Z"
    },
    "City": {
      "type": "string",
      "description": "The client\u2019s city.",
      "example": "San Francisco"
    },
    "ClientCreditCard": {
      "$ref": "#/components/schemas/ClientCreditCard",
      "description": "Contains information about the client\u2019s credit card."
    },
    "ClientIndexes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AssignedClientIndex"
      },
      "description": "Contains a list of the indexes and client index values to be assigned to the client. If an index is already assigned to the client, it is overwritten with the passed index value. You cannot currently remove client indexes using the Public API. Only the indexes passed in the request are returned in the response.",
      "example": [
        {}
      ]
    },
    "ClientRelationships": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ClientRelationship"
      },
      "description": "Contains information about client relationships that were added or updated for the client. This parameter does not include all of the relationships assigned to the client, only the ones passed in the request.",
      "example": [
        {}
      ]
    },
    "Country": {
      "type": "string",
      "description": "The country in which the client is located.",
      "example": "US"
    },
    "CreationDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date when the client was added to the business, either by the client from the online store or by a staff member at the subscriber\u2019s business. This value always returns in the format yyyy-mm-ddThh:mm:ss:ms.",
      "example": "2026-05-28T14:30:00Z"
    },
    "CustomClientFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CustomClientFieldValue"
      },
      "description": "Contains information about the custom fields used for clients in the business.",
      "example": [
        {}
      ]
    },
    "Email": {
      "type": "string",
      "description": "The client\u2019s email address.",
      "example": "kinlane@example.com"
    },
    "EmergencyContactInfoEmail": {
      "type": "string",
      "description": "The email address of the client\u2019s emergency contact.<br /> For more information, see [Children\u2019s program features(emergency contact information)](https://support.mindbodyonline.com/s/article/20325928 3-Children-s-program-features-emergency-contact-information?languag e=en_US).",
      "example": "kinlane@example.com"
    },
    "EmergencyContactInfoName": {
      "type": "string",
      "description": "The name of the client\u2019s emergency contact.",
      "example": "example-value"
    },
    "EmergencyContactInfoPhone": {
      "type": "string",
      "description": "The phone number of the client\u2019s emergency contact.",
      "example": "+15551234567"
    },
    "EmergencyContactInfoRelationship": {
      "type": "string",
      "description": "The client\u2019s relationship with the emergency contact, for example, mother or spouse.",
      "example": "example-value"
    },
    "FirstAppointmentDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date of the client\u2019s first booked appointment at the business.",
      "example": "2026-05-28T14:30:00Z"
    },
    "Gender": {
      "type": "string",
      "description": "The client\u2019s gender.",
      "example": "example-value"
    },
    "HomeLocation": {
      "$ref": "#/components/schemas/Location",
      "description": "Sets the client\u2019s home location to the passed location, based on its ID."
    },
    "HomePhone": {
      "type": "string",
      "description": "The client\u2019s home phone number.",
      "example": "+15551234567"
    },
    "IsCompany": {
      "type": "boolean",
      "description": "When `true`, indicates that the client should be marked as a company at the business.<br /> When `false`, indicates the client is an individual and does not represent a company.",
      "example": true
    },
    "IsProspect": {
      "type": "boolean",
      "description": "This value is set only if the business owner allows individuals to be prospects.<br /> If the business owner has enabled the setting to default new client as a Prospect, the isProspect value will always be true. Otherwise,<br /> When `true`, indicates that the client should be marked as a prospect for the business.<br /> When `false`, indicates that the client should not be marked as a prospect for the business.",
      "example": true
    },
    "LastFormulaNotes": {
      "type": "string",
      "description": "The last [formula note](https://support.mindbodyonline.com/s/article/203259903-Appoin tments-Formula-notes?language=en_US) entered for the client.",
      "example": "Example note for Mindbody Public API."
    },
    "LastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The UTC date and time when the client\u2019s information was last modified.",
      "example": "2026-05-28T14:30:00Z"
    },
    "Liability": {
      "$ref": "#/components/schemas/Liability",
      "description": "Contains the client\u2019s liability agreement information for the business."
    },
    "LiabilityRelease": {
      "type": "boolean",
      "description": "When `true`, sets the client\u2019s liability information as follows: * `IsReleased` is set to true. * `AgreementDate` is set to the time zone of the business when the call was processed. * `ReleasedBy` is set to `null` if the call is made by the client, `0` if the call was made by the business owner, or to a specific staff member\u2019s ID if a staff member made the call. When `false`, sets the client\u2019s liability information as follows: * `IsReleased` is set to `false`. * `AgreementDate` is set to `null`",
      "example": true
    },
    "MembershipIcon": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the membership icon displayed next to the client\u2019s name, if the client has a membership on their account.",
      "example": 1
    },
    "MiddleName": {
      "type": "string",
      "description": "The client\u2019s middle name.",
      "example": "example-value"
    },
    "MobilePhone": {
      "type": "string",
      "description": "The client\u2019s mobile phone number.",
      "example": "+15551234567"
    },
    "MobileProvider": {
      "type": "integer",
      "format": "int32",
      "description": "The client's mobile provider.",
      "example": 1
    },
    "NewId": {
      "type": "string",
      "description": "The new RSSID to be used for the client. Use `NewId` to assign a specific alphanumeric value to be a client\u2019s ID. 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 value is already in use, the call returns an error. Note: NewId value cannot fall within the reserved default ID range (100000000 -&gt; 101000000)",
      "example": "example-value"
    },
    "Notes": {
      "type": "string",
      "description": "Any notes entered on the client\u2019s account by staff members. This value should never be shown to clients unless the business owner has a specific reason for showing them.",
      "example": "Example note for Mindbody Public API."
    },
    "PhotoUrl": {
      "type": "string",
      "description": "The URL for the client\u2019s photo, if one has been uploaded.",
      "example": "https://example.mindbodyonline.com/resource/abc123"
    },
    "PostalCode": {
      "type": "string",
      "description": "The client\u2019s postal code.",
      "example": "94110"
    },
    "ProspectStage": {
      "$ref": "#/components/schemas/ProspectStage",
      "description": "Contains information about the client [prospect stage](https://support.mindbodyonline.com/s/article/206176457-Prosp ect-Stages?language=en_US)."
    },
    "RedAlert": {
      "type": "string",
      "description": "Contains any red alert information entered by the business owner for the client.",
      "example": "example-value"
    },
    "ReferredBy": {
      "type": "string",
      "description": "Specifies how the client was referred to the business. You can get a list of possible strings using the `GET ClientReferralTypes` endpoint.<br /> For more information, see [Referral types and referral subtypes](https://support.mindbodyonline.com/s/article/203259393-Re ferral-types-and-referral-subtypes?language=en_US).",
      "example": "example-value"
    },
    "SalesReps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SalesRep"
      },
      "description": "Contains information about the sales representatives to be assigned to the new client.",
      "example": [
        {}
      ]
    },
    "SiteId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the site.",
      "example": -99
    },
    "State": {
      "type": "string",
      "description": "The client\u2019s state.",
      "example": "CA"
    },
    "Status": {
      "type": "string",
      "description": "The client\u2019s status.",
      "example": "Active"
    },
    "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
    },
    "UniqueId": {
      "type": "integer",
      "format": "int32",
      "description": "The client\u2019s system-generated ID at the business. This value cannot be changed by business owners and is always unique across all clients at the business. This ID is not widely used in the Public API, but can be used by your application to uniquely identify clients.",
      "example": 123456
    },
    "WorkExtension": {
      "type": "string",
      "description": "The client\u2019s work phone extension number.",
      "example": "example-value"
    },
    "WorkPhone": {
      "type": "string",
      "description": "The client\u2019s work phone number.",
      "example": "+15551234567"
    },
    "YellowAlert": {
      "type": "string",
      "description": "Contains any yellow alert information entered by the business owner for the client.",
      "example": "example-value"
    },
    "SendScheduleEmails": {
      "type": "boolean",
      "description": "When `true`, indicates that the client opts to receive schedule emails. Default : **false**",
      "example": true
    },
    "SendAccountEmails": {
      "type": "boolean",
      "description": "When `true`, indicates that the client opts to receive account emails. Default : **false**",
      "example": true
    },
    "SendPromotionalEmails": {
      "type": "boolean",
      "description": "When `true`, indicates that the client opts to receive promotional emails. Default : **false**",
      "example": true
    },
    "SendScheduleTexts": {
      "type": "boolean",
      "description": "When `true`, indicates that the client opts to receive schedule texts.",
      "example": true
    },
    "SendAccountTexts": {
      "type": "boolean",
      "description": "When `true`, indicates that the client opts to receive account texts.",
      "example": true
    },
    "SendPromotionalTexts": {
      "type": "boolean",
      "description": "When `true`, indicates that the client opts to receive promotional texts.",
      "example": true
    },
    "LockerNumber": {
      "type": "string",
      "description": "The clients locker number.",
      "example": "example-value"
    },
    "ReactivateInactiveClient": {
      "type": "boolean",
      "description": "When `true`, indicates that the client opts to reactive existing Inactive client.",
      "example": true
    },
    "LeadChannelId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the LeadChannel from LeadManagement. This parameter is required by LeadManagement to track the LeadChannel from where the new client is added. If this value is not supplied then it won't save anything.",
      "example": 123456
    }
  }
}