Mindbody · Schema

AddSiteClientIndexRequest

Implementation of the 'AddSiteClientIndexRequest' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
ClientIndexName	string	The name of the client index.
Active	boolean	Indicates if Client Index is Active
ShowOnNewClient	boolean	Indicates if Client Index is shown on a new client profile
ShowOnEnrollmentRoster	boolean	Indicates if Client Index is shown on Enrollement Roster
EditOnEnrollmentRoster	boolean	Indicates if Client Index can be edited on Enrollement Roster
SortOrder	integer	Indicates sort order
ShowInConsumerMode	boolean	Indicates if Client Index is shown in consumer mode.
RequiredConsumerMode	boolean	Indicates if the index is required when creating profiles in consumer mode.
RequiredBizMode	boolean	Indicates if the index is required when creating profiles in business mode.

View JSON Schema on GitHub

JSON Schema

{
  "$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-site-client-index-request-schema.json",
  "title": "AddSiteClientIndexRequest",
  "description": "Implementation of the 'AddSiteClientIndexRequest' model.",
  "type": "object",
  "properties": {
    "ClientIndexName": {
      "type": "string",
      "description": "The name of the client index.",
      "example": "example-value"
    },
    "Active": {
      "type": "boolean",
      "description": "Indicates if Client Index is Active",
      "example": true
    },
    "ShowOnNewClient": {
      "type": "boolean",
      "description": "Indicates if Client Index is shown on a new client profile",
      "example": true
    },
    "ShowOnEnrollmentRoster": {
      "type": "boolean",
      "description": "Indicates if Client Index is shown on Enrollement Roster",
      "example": true
    },
    "EditOnEnrollmentRoster": {
      "type": "boolean",
      "description": "Indicates if Client Index can be edited on Enrollement Roster",
      "example": true
    },
    "SortOrder": {
      "type": "integer",
      "format": "int32",
      "description": "Indicates sort order",
      "example": 1
    },
    "ShowInConsumerMode": {
      "type": "boolean",
      "description": "Indicates if Client Index is shown in consumer mode.",
      "example": true
    },
    "RequiredConsumerMode": {
      "type": "boolean",
      "description": "Indicates if the index is required when creating profiles in consumer mode.",
      "example": true
    },
    "RequiredBizMode": {
      "type": "boolean",
      "description": "Indicates if the index is required when creating profiles in business mode.",
      "example": true
    }
  }
}