Mindbody · Schema
ClientRelationship
Implementation of the 'ClientRelationship' model. A relation between two clients.
FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks
Properties
| Name | Type | Description |
|---|---|---|
| RelatedClientId | string | The RSSID of the related client. |
| RelatedUniqueId | integer | The UniqueId of the related client. |
| Relationship | object | Contains details about the relationship between two clients. |
| RelationshipName | string | The name of the relationship of the related client. |
| Delete | boolean | When true, the associated relationship is removed from the client’s list of relationships. This property is ignored in all other use cases. Default: *false* |
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-client-relationship-schema.json",
"title": "ClientRelationship",
"description": "Implementation of the 'ClientRelationship' model. A relation between two clients.",
"type": "object",
"properties": {
"RelatedClientId": {
"type": "string",
"description": "The RSSID of the related client.",
"example": "example-value"
},
"RelatedUniqueId": {
"type": "integer",
"format": "int32",
"description": "The UniqueId of the related client.",
"example": 123456
},
"Relationship": {
"$ref": "#/components/schemas/Relationship",
"description": "Contains details about the relationship between two clients."
},
"RelationshipName": {
"type": "string",
"description": "The name of the relationship of the related client.",
"example": "example-value"
},
"Delete": {
"type": "boolean",
"description": "When true, the associated relationship is removed from the client\u2019s list of relationships. This property is ignored in all other use cases. Default: *false*",
"example": true
}
}
}