Mindbody · Schema

UpdateContactLogRequest

Implementation of the 'UpdateContactLogRequest' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name Type Description
Id integer The ID of the contact log being updated.
Test boolean When `true`, indicates that this is a test request and no data is inserted into the subscriber’s database.
When `false`, the database is updated.
AssignedToStaffId integer The ID of the staff member to whom the contact log is now being assigned.
Text string The contact log’s new text.
ContactName string The name of the new person to be contacted by the assigned staff member.
FollowupByDate string The new date by which the assigned staff member should complete this contact log.
ContactMethod string The new method by which the client wants to be contacted.
IsComplete boolean When `true`, indicates that the contact log is complete. When `false`, indicates the contact log isn’t complete.
Comments array Contains information about the comments being updated or added to the contact log. Comments that have an ID of `0` are added to the contact log.
Types array Contains information about the contact logs types being assigned to the contact log, in addition to the contact log types that are already assigned.
View JSON Schema on GitHub

JSON Schema

public-api-v6-update-contact-log-request-schema.json Raw ↑
{
  "$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-contact-log-request-schema.json",
  "title": "UpdateContactLogRequest",
  "description": "Implementation of the 'UpdateContactLogRequest' model.",
  "type": "object",
  "properties": {
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the contact log being updated.",
      "example": 123456
    },
    "Test": {
      "type": "boolean",
      "description": "When `true`, indicates that this is a test request and no data is inserted into the subscriber\u2019s database.<br /> When `false`, the database is updated.",
      "example": true
    },
    "AssignedToStaffId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the staff member to whom the contact log is now being assigned.",
      "example": 123456
    },
    "Text": {
      "type": "string",
      "description": "The contact log\u2019s new text.",
      "example": "example-value"
    },
    "ContactName": {
      "type": "string",
      "description": "The name of the new person to be contacted by the assigned staff member.",
      "example": "example-value"
    },
    "FollowupByDate": {
      "type": "string",
      "format": "date-time",
      "description": "The new date by which the assigned staff member should complete this contact log.",
      "example": "2026-05-28T14:30:00Z"
    },
    "ContactMethod": {
      "type": "string",
      "description": "The new method by which the client wants to be contacted.",
      "example": "example-value"
    },
    "IsComplete": {
      "type": "boolean",
      "description": "When `true`, indicates that the contact log is complete. When `false`, indicates the contact log isn\u2019t complete.",
      "example": true
    },
    "Comments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UpdateContactLogComment"
      },
      "description": "Contains information about the comments being updated or added to the contact log. Comments that have an ID of `0` are added to the contact log.",
      "example": [
        {}
      ]
    },
    "Types": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UpdateContactLogType"
      },
      "description": "Contains information about the contact logs types being assigned to the contact log, in addition to the contact log types that are already assigned.",
      "example": [
        {}
      ]
    }
  }
}