Skip to content

StoreTemplate ​

Type: schema

TypeScript Definition ​

typescript
StoreTemplate: {{
            id?: $Read<string>;
            name: string;
            description?: string | null;
            /** @description What the template is for, e.g. `email`, `invoice`, `terms-of-service`, `refund-policy`, `whatsapp`. */
            template_type: string;
            /** @description example - signup, order-confirmation, order-cancelled, order-refunded, cart-abandoned, etc. */
            activity?: string | null;
            /** @description to be used in email subject or notification heading if provided. */
            content_title?: string | null;
            /** @enum {unknown} */
            content_type: "html" | "markdown" | "plaintext";
            content: string;
            /** Format: date-time */
            created_at?: $Read<string>;
            /** Format: date-time */
            modified_at?: $Read<string>;
        };
        /** SubscriptionSetting */
}

OpenAPI Schema ​

json
{
  "title": "StoreTemplate",
  "type": "object",
  "required": [
    "name",
    "template_type",
    "content_type",
    "content"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "template_type": {
      "description": "What the template is for, e.g. `email`, `invoice`, `terms-of-service`, `refund-policy`, `whatsapp`.",
      "type": "string"
    },
    "activity": {
      "description": "example - signup, order-confirmation, order-cancelled, order-refunded, cart-abandoned, etc.",
      "type": [
        "string",
        "null"
      ]
    },
    "content_title": {
      "description": "to be used in email subject or notification heading if provided.",
      "type": [
        "string",
        "null"
      ]
    },
    "content_type": {
      "enum": [
        "html",
        "markdown",
        "plaintext"
      ]
    },
    "content": {
      "type": "string"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "x-tags": [
    "Store"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: