AhaSend · JSON Structure

Openapi V2 Create Route Request Structure

CreateRouteRequest schema from AhaSend API

Type: object Properties: 8 Required: 2
EmailTransactional EmailDeveloper ToolsSMTPWebhooks

CreateRouteRequest is a JSON Structure definition published by AhaSend, describing 8 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name url recipient attachments headers group_by_message_id strip_replies enabled

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/ahasend/refs/heads/main/json-structure/openapi-v2-create-route-request-structure.json",
  "name": "CreateRouteRequest",
  "description": "CreateRouteRequest schema from AhaSend API",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 255,
      "description": "Route name",
      "example": "Example Name"
    },
    "url": {
      "type": "uri",
      "description": "Webhook URL for the route",
      "example": "https://example.com"
    },
    "recipient": {
      "type": "string",
      "maxLength": 255,
      "description": "Recipient filter",
      "example": "example_value"
    },
    "attachments": {
      "type": "boolean",
      "description": "Whether to include attachments in webhooks",
      "default": false,
      "example": true
    },
    "headers": {
      "type": "boolean",
      "description": "Whether to include headers in webhooks",
      "default": false,
      "example": true
    },
    "group_by_message_id": {
      "type": "boolean",
      "description": "Whether to group by message ID",
      "default": false,
      "example": true
    },
    "strip_replies": {
      "type": "boolean",
      "description": "Whether to strip reply content",
      "default": false,
      "example": true
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the route is enabled",
      "default": true,
      "example": true
    }
  },
  "required": [
    "name",
    "url"
  ],
  "example": {
    "name": "Support Route",
    "url": "https://example.com/webhook",
    "enabled": true
  }
}