InviteTemplatePostRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/getsmileapi/main/json-schema/getsmileapi-invite-template-post-request-schema.json",
  "title": "InviteTemplatePostRequest",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/getsmileapi-smile-api-openapi.yml#/components/schemas/InviteTemplatePostRequest",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Template name",
      "minLength": 1,
      "maxLength": 64
    },
    "company": {
      "type": "object",
      "required": [
        "name",
        "logoUrl"
      ],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Company name that it will appear in the invite landing page and email or sms message"
        },
        "logoUrl": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Company logo that will appear in the invite email and landing page"
        }
      }
    },
    "email": {
      "type": "object",
      "required": [
        "sendEmail",
        "senderName",
        "replyAddress",
        "subject",
        "body"
      ],
      "properties": {
        "sendEmail": {
          "type": "boolean",
          "description": "Send email using this template (boolean value: true/false)"
        },
        "senderName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Sender name that it will appear in the email message"
        },
        "replyAddress": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Reply-to address that will be shown when replying to an invite email",
          "format": "email"
        },
        "subject": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Subject that it will appear in the email message"
        },
        "body": {
          "type": "string",
          "minLength": 1,
          "maxLength": 5000,
          "description": "Text that it will appear in email message"
        }
      }
    },
    "landingPage": {
      "type": "object",
      "required": [
        "header",
        "description",
        "button"
      ],
      "properties": {
        "header": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Header text that will appear in the landing page"
        },
        "description": {
          "type": "string",
          "minLength": 1,
          "maxLength": 5000,
          "description": "Description of the landing page"
        },
        "button": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Text that it will appear in the landing page"
        }
      }
    },
    "successPage": {
      "type": "object",
      "required": [
        "header",
        "description",
        "button"
      ],
      "properties": {
        "header": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Header text that will appear in the success page"
        },
        "description": {
          "type": "string",
          "minLength": 1,
          "maxLength": 5000,
          "description": "Description of the success page after an account has been linked or data has been uploaded"
        },
        "button": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Text that it will appear in the landing page"
        }
      }
    }
  },
  "required": [
    "name",
    "company",
    "email",
    "landingPage",
    "successPage"
  ]
}