Mindbody · JSON Structure

Public Api V6 Add Promo Code Request Structure

Implementation of the 'AddPromoCodeRequest' model.

Type: object Properties: 11
FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

AddPromoCodeRequest is a JSON Structure definition published by Mindbody, describing 11 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Code Name Active Discount ActivationDate ExpirationDate MaxUses DaysAfterCloseDate AllowOnline DaysValid ApplicableItems

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-structure/public-api-v6-add-promo-code-request-structure.json",
  "name": "AddPromoCodeRequest",
  "description": "Implementation of the 'AddPromoCodeRequest' model.",
  "type": "object",
  "properties": {
    "Code": {
      "type": "string",
      "description": "The code of the promocode.",
      "example": "example-value"
    },
    "Name": {
      "type": "string",
      "description": "The name of the promocode.",
      "example": "Sunset Yoga Studio"
    },
    "Active": {
      "type": "boolean",
      "description": "Indicates that promocode is active. Default: **true**",
      "example": true
    },
    "Discount": {
      "$ref": "#/components/schemas/Discount",
      "description": "Discount info"
    },
    "ActivationDate": {
      "type": "datetime",
      "description": "The date of the promocode activation. Default: **today\u2019s date**",
      "example": "2026-05-28T14:30:00Z"
    },
    "ExpirationDate": {
      "type": "datetime",
      "description": "The date of the promocode expiration. Default: **a months from today\u2019s date**",
      "example": "2026-05-28T14:30:00Z"
    },
    "MaxUses": {
      "type": "int32",
      "description": "The maximun number of uses. A use is considered a single sale.",
      "example": 1
    },
    "DaysAfterCloseDate": {
      "type": "int32",
      "description": "The number of days a client has to use a promocode after they are no longer a prospect.",
      "example": 1
    },
    "AllowOnline": {
      "type": "boolean",
      "description": "Indicates if promocode can be redeemed online in consumer mode. Default: **false**",
      "example": true
    },
    "DaysValid": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Indicates what days of the week promocode is valid. Defaults to 7 days of the week. Possible values are: * Monday * Tuesday * Wednesday * Thursday * Friday * Saturday * Sunday",
      "example": [
        "example-value"
      ]
    },
    "ApplicableItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ApplicableItem"
      },
      "description": "Contains information about a promocode applicable items. See ApplicableItems for a details of the `ApplicableItems` object.",
      "example": [
        {}
      ]
    }
  }
}