PatchSubscriptionRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-schema/webhooks-api-patch-subscription-request-schema.json",
  "title": "PatchSubscriptionRequest",
  "description": "Implementation of the 'PatchSubscriptionRequest' model. A request to patch update a subscription",
  "type": "object",
  "properties": {
    "eventIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of event IDs that you want to update or subscribe to.",
      "example": [
        "example-value"
      ]
    },
    "eventSchemaVersion": {
      "type": "number",
      "format": "double",
      "description": "The event schema version associated with the subscription. Currently, this is always `1`.",
      "example": 1.0
    },
    "referenceId": {
      "type": "string",
      "description": "An arbitrary field that you can set to a value of your choice. Mindbody stores and returns this value for the subscription you are activating. Most commonly, this field stores a GUID that you can use in your application.",
      "example": "example-value"
    },
    "status": {
      "type": "string",
      "description": "The subscription\u2019s current status, as of the last update.",
      "example": "example-value"
    },
    "webhookUrl": {
      "type": "string",
      "description": "The URL registered as the target of the webhook deliveries. Mindbody posts the event notifications to this URL. Webhook URL Requirements lists considerations and requirements for this URL.",
      "example": "https://example.mindbodyonline.com/resource/abc123"
    }
  }
}