EmailSequenceRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/crevio-co/json-schema/crevio-co-email-sequence-request-schema.json",
  "title": "EmailSequenceRequest",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/crevio-co-openapi.json#/components/schemas/EmailSequenceRequest",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Internal name, shown in the dashboard."
    },
    "trigger": {
      "type": "object",
      "properties": {
        "event": {
          "type": "string",
          "enum": [
            "manual",
            "lead.created",
            "customer.tag_added",
            "order.paid"
          ],
          "description": "What enrolls people. `manual` enrolls only through `POST /sequences/{sequence_id}/enrollments`."
        },
        "tag_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "`customer.tag_added` only: the tag (`tag_...`) that enrolls. Form signups apply their tags after double opt-in, so a form's tag is the newsletter trigger."
        },
        "product_ids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "`order.paid` only: enroll buyers of these products (`prod_...`). Empty means any product."
        }
      },
      "required": [
        "event"
      ]
    },
    "exit": {
      "type": "object",
      "properties": {
        "on_purchase": {
          "type": "string",
          "enum": [
            "none",
            "any",
            "products"
          ],
          "description": "Stop when the person pays for an order placed after enrolling: `any` order, only orders containing `product_ids`, or `none`."
        },
        "product_ids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Products (`prod_...`) that count when `on_purchase` is `products`."
        },
        "tag_ids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Stop when the person gets any of these tags (`tag_...`)."
        },
        "on_reply": {
          "type": "boolean",
          "description": "Stop when the person replies. Replies are only seen when they reach a Crevio inbox, so with this on and no `reply_to`, replies go to the account's inbox."
        }
      }
    },
    "send_days": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "sun",
          "mon",
          "tue",
          "wed",
          "thu",
          "fri",
          "sat"
        ]
      },
      "description": "Weekdays a step may go out, in the business's time zone. Defaults to every day."
    },
    "from": {
      "type": [
        "string",
        "null"
      ],
      "description": "Sender address on the account's verified domain. Defaults to the account's sending address."
    },
    "reply_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "Where replies go. Defaults to the account's Crevio inbox when `exit.on_reply` is on, otherwise the support email."
    },
    "styled": {
      "type": "boolean",
      "description": "Wrap each email in the branded layout. Defaults to true."
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Caller-owned key/value pairs."
    },
    "steps": {
      "type": "array",
      "maxItems": 50,
      "items": {
        "type": "object",
        "properties": {
          "subject": {
            "type": "string",
            "description": "Takes the same variables as `body`."
          },
          "preview_text": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 255,
            "description": "Inbox preview line. Takes the same variables as `body`."
          },
          "body": {
            "type": "string",
            "description": "Email body (HTML or plain text). Variables, filled per recipient: {{customer.first_name}}, {{customer.last_name}}, {{customer.email}}, {{business.name}}, {{product.name}}, {{product.url}}, {{order.product_names}}, {{tag.name}}, {{form.name}}, {{customer.fields.<key>}}. `product.*` is the product whose purchase enrolled them (`order.paid` sequences only), `tag.name` the tag that enrolled them (`tag_added`), `form.name` the form a new lead came through (`lead_created`, empty for leads from elsewhere). `customer.fields.<key>` reads `<key>` from the customer's `metadata` when the email is sent; the key takes letters, digits and underscores. A blank value renders as nothing, or as the default in `{{ customer.first_name | default: \"there\" }}`. Any other `{{ }}` is rejected."
          },
          "delay": {
            "type": "object",
            "properties": {
              "amount": {
                "type": "integer",
                "minimum": 0,
                "description": "How many `unit`s to wait. `0` sends right away."
              },
              "unit": {
                "type": "string",
                "enum": [
                  "minutes",
                  "hours",
                  "days",
                  "weeks"
                ]
              }
            },
            "required": [
              "amount",
              "unit"
            ],
            "description": "Wait after the previous step's send (after enrolling, for the first step)."
          }
        },
        "required": [
          "subject",
          "body"
        ]
      },
      "description": "The emails in send order. Edit them later through the step endpoints."
    }
  },
  "required": [
    "name"
  ]
}