Hubfly spaceDocs
Console

Mail API · Dashboard

Templates, images & activity

Manage saved content and hosted images, then inspect outbound and inbound message history.

Base URL: https://api.hubfly.space. Use a Dashboard bearer token authorized for the project. Replace :projectId in each path with the Dashboard project ID. JSON routes use Content-Type: application/json.

How to use these endpoints

  1. Save a template or draft and upload hosted images when you need them in HTML mail.
  2. Keep public image URLs available after the message is sent.
  3. Read activity with its cursor to browse older outbound and inbound records.
  4. Interpret queue acceptance as local handoff, not final recipient delivery.

Read activity

curl
curl "https://api.hubfly.space/api/v1/projects/$PROJECT_ID/mail/activity?limit=20" \
  -H "Authorization: Bearer $HUBFLY_TOKEN"

The response uses the standard Dashboard envelope: ok, data, and meta on success. On failure, use the returned error code and message to decide whether to correct the request or retry. The exact schema and response codes for each operation are below.

Endpoint reference

Dashboard endpoints (10)

These JSON routes are served by the Hubfly space Dashboard API and use Dashboard project authorization.

Open interactive API explorer
GETRead project mail activityDetails +/api/v1/projects/:projectId/mail/activity

Returns this project tenant’s paginated outbound submission history and inbound forwarding records. Outbound includes sends made with the Dashboard composer and with direct REST or SMTP credentials.

  • handed_to_postfix means accepted by the local mail queue; it does not prove delivery to the recipient. Use before with next_cursor for older outbound records.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
beforequeryNostring—
limitqueryNonumber—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "outbound": {
              "type": "object",
              "properties": {
                "items": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "envelope_from": {
                        "type": "string"
                      },
                      "status": {
                        "type": "string"
                      },
                      "error": {
                        "type": "string"
                      },
                      "created_at": {
                        "type": "string"
                      },
                      "updated_at": {
                        "type": "string"
                      },
                      "size_bytes": {
                        "type": "number"
                      },
                      "attempt_count": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "id",
                      "envelope_from",
                      "status",
                      "error",
                      "created_at",
                      "updated_at",
                      "size_bytes",
                      "attempt_count"
                    ],
                    "additionalProperties": false
                  }
                },
                "next_cursor": {
                  "type": "string"
                }
              },
              "required": [
                "items",
                "next_cursor"
              ],
              "additionalProperties": false
            },
            "inbound": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "recipient": {
                    "type": "string"
                  },
                  "sender": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "created_at": {
                    "type": "string"
                  },
                  "destinations": {
                    "type": "string"
                  }
                },
                "required": [
                  "id",
                  "recipient",
                  "sender",
                  "status",
                  "created_at",
                  "destinations"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "outbound",
            "inbound"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "outbound": {
          "items": [
            {
              "id": "string",
              "envelope_from": "string",
              "status": "string",
              "error": "string",
              "created_at": "string",
              "updated_at": "string",
              "size_bytes": 0,
              "attempt_count": 0
            }
          ],
          "next_cursor": "string"
        },
        "inbound": [
          {
            "id": "string",
            "recipient": "string",
            "sender": "string",
            "status": "string",
            "created_at": "string",
            "destinations": "string"
          }
        ]
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
GETRead mail analyticsDetails +/api/v1/projects/:projectId/mail/analytics

Return daily outbound, inbound and attention counts for the last days (7 by default, or 30), totals by status, active routes, addresses and credentials, and the event retention period.

  • Requires the project:read project permission on a Mail project.
  • days other than 7 or 30 returns 400 INVALID_MAIL_ANALYTICS_RANGE; 404 MAIL_PROJECT_NOT_FOUND when the Mail project is not provisioned.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
daysqueryNonumber—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "days": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            },
            "daily": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "date": {
                    "type": "string"
                  },
                  "outbound": {
                    "type": "number"
                  },
                  "inbound": {
                    "type": "number"
                  },
                  "attention": {
                    "type": "number"
                  }
                },
                "required": [
                  "date",
                  "outbound",
                  "inbound",
                  "attention"
                ],
                "additionalProperties": false
              }
            },
            "counts": {
              "type": "object",
              "properties": {
                "outbound": {
                  "type": "number"
                },
                "inbound": {
                  "type": "number"
                },
                "pending": {
                  "type": "number"
                },
                "accepted": {
                  "type": "number"
                },
                "attention": {
                  "type": "number"
                }
              },
              "required": [
                "outbound",
                "inbound",
                "pending",
                "accepted",
                "attention"
              ],
              "additionalProperties": false
            },
            "active_routes": {
              "type": "number"
            },
            "active_addresses": {
              "type": "number"
            },
            "active_credentials": {
              "type": "number"
            },
            "event_retention_days": {
              "type": "number"
            },
            "delivery_confirmation_available": {
              "type": "boolean"
            },
            "updated_at": {
              "type": "string"
            }
          },
          "required": [
            "days",
            "timezone",
            "daily",
            "counts",
            "active_routes",
            "active_addresses",
            "active_credentials",
            "event_retention_days",
            "delivery_confirmation_available",
            "updated_at"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "days": 0,
        "timezone": "string",
        "daily": [
          {
            "date": "string",
            "outbound": 0,
            "inbound": 0,
            "attention": 0
          }
        ],
        "counts": {
          "outbound": 0,
          "inbound": 0,
          "pending": 0,
          "accepted": 0,
          "attention": 0
        },
        "active_routes": 0,
        "active_addresses": 0,
        "active_credentials": 0,
        "event_retention_days": 0,
        "delivery_confirmation_available": true,
        "updated_at": "string"
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
POSTUpload a hosted Mail imageDetails +/api/v1/projects/:projectId/mail/assets/create

Stores a JPEG, PNG, GIF or WebP image for use in Mail templates and returns its immutable public URL. The project owns the asset metadata.

  • Each image is limited to 5 MB. Use the returned URL in HTML content; do not use this endpoint for message attachments.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—

JSON request body

FieldType / allowed valuesRequired
filenamestringYes
contentTypestringYes
contentBase64stringYes
Complete request schema
{
  "type": "object",
  "properties": {
    "filename": {
      "type": "string"
    },
    "contentType": {
      "type": "string"
    },
    "contentBase64": {
      "type": "string"
    }
  },
  "required": [
    "filename",
    "contentType",
    "contentBase64"
  ],
  "additionalProperties": false
}
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "projectId": {
              "type": "string"
            },
            "publicUrl": {
              "type": "string"
            },
            "contentType": {
              "type": "string"
            },
            "sizeBytes": {
              "type": "number"
            },
            "createdAt": {
              "type": "string",
              "description": "Date string"
            }
          },
          "required": [
            "id",
            "projectId",
            "publicUrl",
            "contentType",
            "sizeBytes",
            "createdAt"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "id": "string",
        "projectId": "string",
        "publicUrl": "string",
        "contentType": "string",
        "sizeBytes": 0,
        "createdAt": "string"
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
GETList hosted Mail imagesDetails +/api/v1/projects/:projectId/mail/assets

Lists image assets uploaded by this project, with content type, byte size and public URL.

  • Image URLs are public and immutable so sent messages retain their images.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "publicUrl": {
                "type": "string"
              },
              "contentType": {
                "type": "string"
              },
              "sizeBytes": {
                "type": "number"
              },
              "createdAt": {
                "type": "string",
                "description": "Date string"
              }
            },
            "required": [
              "id",
              "publicUrl",
              "contentType",
              "sizeBytes",
              "createdAt"
            ],
            "additionalProperties": false
          }
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": [
        {
          "id": "string",
          "publicUrl": "string",
          "contentType": "string",
          "sizeBytes": 0,
          "createdAt": "string"
        }
      ],
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
GETList mail eventsDetails +/api/v1/projects/:projectId/mail/events

List outbound and inbound messages with subject, sender, recipients, status, size and per-recipient delivery attempts. Filter by direction (outbound, inbound), status (pending, accepted, attention) and search, and page with before set to the previous next_cursor.

  • Requires the project:read project permission on a Mail project.
  • limit is 1–100 (default 50); search is cut to 256 characters.
  • Events are kept for event_retention_days; 502 MAIL_ACTIVITY_UNAVAILABLE when the mail service cannot be reached.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
directionqueryNostring—
statusqueryNostring—
searchqueryNostring—
beforequeryNostring—
limitqueryNonumber—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "items": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "direction": {
                    "type": "string",
                    "enum": [
                      "inbound",
                      "outbound"
                    ]
                  },
                  "subject": {
                    "type": "string"
                  },
                  "from": {
                    "type": "string"
                  },
                  "to": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "status": {
                    "type": "string"
                  },
                  "error": {
                    "type": "string"
                  },
                  "created_at": {
                    "type": "string"
                  },
                  "updated_at": {
                    "type": "string"
                  },
                  "size_bytes": {
                    "type": "number"
                  },
                  "source": {
                    "type": "string"
                  },
                  "attempts": {
                    "type": "number"
                  },
                  "message_id": {
                    "type": "string"
                  },
                  "recipients": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "address": {
                          "type": "string"
                        },
                        "status": {
                          "type": "string"
                        },
                        "error": {
                          "type": "string"
                        },
                        "attempts": {
                          "type": "number"
                        },
                        "next_attempt_at": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "address",
                        "status",
                        "error",
                        "attempts",
                        "next_attempt_at"
                      ],
                      "additionalProperties": false
                    }
                  }
                },
                "required": [
                  "id",
                  "direction",
                  "subject",
                  "from",
                  "to",
                  "status",
                  "error",
                  "created_at",
                  "updated_at",
                  "size_bytes",
                  "source",
                  "attempts",
                  "message_id",
                  "recipients"
                ],
                "additionalProperties": false
              }
            },
            "next_cursor": {
              "type": "string"
            },
            "event_retention_days": {
              "type": "number"
            }
          },
          "required": [
            "items",
            "next_cursor",
            "event_retention_days"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "items": [
          {
            "id": "string",
            "direction": "inbound",
            "subject": "string",
            "from": "string",
            "to": [
              "string"
            ],
            "status": "string",
            "error": "string",
            "created_at": "string",
            "updated_at": "string",
            "size_bytes": 0,
            "source": "string",
            "attempts": 0,
            "message_id": "string",
            "recipients": [
              {
                "address": "string",
                "status": "string",
                "error": "string",
                "attempts": 0,
                "next_attempt_at": "string"
              }
            ]
          }
        ],
        "next_cursor": "string",
        "event_retention_days": 0
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
GETRead a mail eventDetails +/api/v1/projects/:projectId/mail/events/:direction/:messageId

Return one outbound or inbound message with its event timeline; each event has a kind, a timestamp and details such as recipient, reason and matched route IDs.

  • Requires the project:read project permission on a Mail project.
  • A message past the retention period returns 404 MAIL_EVENT_NOT_FOUND.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
directionpathYesstring—
messageIdpathYesstring—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "message": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "direction": {
                  "type": "string",
                  "enum": [
                    "inbound",
                    "outbound"
                  ]
                },
                "subject": {
                  "type": "string"
                },
                "from": {
                  "type": "string"
                },
                "to": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "status": {
                  "type": "string"
                },
                "error": {
                  "type": "string"
                },
                "created_at": {
                  "type": "string"
                },
                "updated_at": {
                  "type": "string"
                },
                "size_bytes": {
                  "type": "number"
                },
                "source": {
                  "type": "string"
                },
                "attempts": {
                  "type": "number"
                },
                "message_id": {
                  "type": "string"
                },
                "recipients": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "address": {
                        "type": "string"
                      },
                      "status": {
                        "type": "string"
                      },
                      "error": {
                        "type": "string"
                      },
                      "attempts": {
                        "type": "number"
                      },
                      "next_attempt_at": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "address",
                      "status",
                      "error",
                      "attempts",
                      "next_attempt_at"
                    ],
                    "additionalProperties": false
                  }
                }
              },
              "required": [
                "id",
                "direction",
                "subject",
                "from",
                "to",
                "status",
                "error",
                "created_at",
                "updated_at",
                "size_bytes",
                "source",
                "attempts",
                "message_id",
                "recipients"
              ],
              "additionalProperties": false
            },
            "events": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "kind": {
                    "type": "string"
                  },
                  "created_at": {
                    "type": "string"
                  },
                  "details": {
                    "type": "object",
                    "properties": {
                      "recipient": {
                        "type": "string"
                      },
                      "reason": {
                        "type": "string"
                      },
                      "source": {
                        "type": "string"
                      },
                      "route_ids": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "nullable": true
                      },
                      "destination_count": {
                        "type": "number"
                      },
                      "recipient_count": {
                        "type": "number"
                      }
                    },
                    "required": [],
                    "additionalProperties": false
                  }
                },
                "required": [
                  "id",
                  "kind",
                  "created_at",
                  "details"
                ],
                "additionalProperties": false
              }
            },
            "event_retention_days": {
              "type": "number"
            }
          },
          "required": [
            "message",
            "events",
            "event_retention_days"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "message": {
          "id": "string",
          "direction": "inbound",
          "subject": "string",
          "from": "string",
          "to": [
            "string"
          ],
          "status": "string",
          "error": "string",
          "created_at": "string",
          "updated_at": "string",
          "size_bytes": 0,
          "source": "string",
          "attempts": 0,
          "message_id": "string",
          "recipients": [
            {
              "address": "string",
              "status": "string",
              "error": "string",
              "attempts": 0,
              "next_attempt_at": "string"
            }
          ]
        },
        "events": [
          {
            "id": 0,
            "kind": "string",
            "created_at": "string",
            "details": {
              "recipient": "string",
              "reason": "string",
              "source": "string",
              "route_ids": [
                "string"
              ],
              "destination_count": 0,
              "recipient_count": 0
            }
          }
        ],
        "event_retention_days": 0
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
POSTCreate a Mail templateDetails +/api/v1/projects/:projectId/mail/templates/create

Creates a project-owned template or draft with subject, text body and supported email-safe content blocks.

  • The visual Templates & Compose interface is marked Coming soon; this endpoint is for integrations that call the documented API directly.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—

JSON request body

FieldType / allowed valuesRequired
namestringYes
subjectstringNo
blocksobject[]No
textBodystringNo
isDraftbooleanNo
Complete request schema
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    },
    "blocks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "image",
              "heading",
              "text",
              "button",
              "divider"
            ]
          },
          "content": {
            "type": "string"
          },
          "src": {
            "type": "string"
          },
          "href": {
            "type": "string"
          },
          "alt": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "additionalProperties": false
      }
    },
    "textBody": {
      "type": "string"
    },
    "isDraft": {
      "type": "boolean"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "projectId": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "subject": {
              "type": "string"
            },
            "blocks": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "image",
                      "heading",
                      "text",
                      "button",
                      "divider"
                    ]
                  },
                  "content": {
                    "type": "string"
                  },
                  "src": {
                    "type": "string"
                  },
                  "href": {
                    "type": "string"
                  },
                  "alt": {
                    "type": "string"
                  }
                },
                "required": [
                  "type"
                ],
                "additionalProperties": false
              }
            },
            "textBody": {
              "type": "string"
            },
            "isDraft": {
              "type": "boolean"
            },
            "createdAt": {
              "type": "string",
              "description": "Date string"
            },
            "updatedAt": {
              "type": "string",
              "description": "Date string"
            }
          },
          "required": [
            "id",
            "projectId",
            "name",
            "subject",
            "blocks",
            "textBody",
            "isDraft",
            "createdAt",
            "updatedAt"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "id": "string",
        "projectId": "string",
        "name": "string",
        "subject": "string",
        "blocks": [
          {
            "type": "image",
            "content": "string",
            "src": "string",
            "href": "string",
            "alt": "string"
          }
        ],
        "textBody": "string",
        "isDraft": true,
        "createdAt": "string",
        "updatedAt": "string"
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
GETList Mail templatesDetails +/api/v1/projects/:projectId/mail/templates

Lists the project’s saved templates and drafts.

  • Templates are scoped to the Mail project and are not shared automatically with other projects.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "createdAt": {
                "type": "string",
                "description": "Date string"
              },
              "updatedAt": {
                "type": "string",
                "description": "Date string"
              },
              "id": {
                "type": "string"
              },
              "projectId": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "subject": {
                "type": "string"
              },
              "blocks": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": [
                        "image",
                        "heading",
                        "text",
                        "button",
                        "divider"
                      ]
                    },
                    "content": {
                      "type": "string"
                    },
                    "src": {
                      "type": "string"
                    },
                    "href": {
                      "type": "string"
                    },
                    "alt": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "type"
                  ],
                  "additionalProperties": false
                }
              },
              "textBody": {
                "type": "string"
              },
              "isDraft": {
                "type": "boolean"
              }
            },
            "required": [
              "createdAt",
              "updatedAt",
              "id",
              "projectId",
              "name",
              "subject",
              "blocks",
              "textBody",
              "isDraft"
            ],
            "additionalProperties": false
          }
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": [
        {
          "createdAt": "string",
          "updatedAt": "string",
          "id": "string",
          "projectId": "string",
          "name": "string",
          "subject": "string",
          "blocks": [
            {
              "type": "image",
              "content": "string",
              "src": "string",
              "href": "string",
              "alt": "string"
            }
          ],
          "textBody": "string",
          "isDraft": true
        }
      ],
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
DELETEDelete a Mail templateDetails +/api/v1/projects/:projectId/mail/templates/:templateId/delete

Deletes a template owned by this project.

  • Deleting a template does not recall messages previously submitted from it.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
templateIdpathYesstring—
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "success": {
              "type": "boolean"
            }
          },
          "required": [
            "success"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "success": true
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }
PUTUpdate a Mail templateDetails +/api/v1/projects/:projectId/mail/templates/:templateId/update

Replaces the supplied template fields and draft state for a project-owned template.

  • Provide the desired block list when changing the layout; updates do not modify already submitted messages.
Request parameters
NameLocationRequiredTypeDescription
projectIdpathYesstring—
templateIdpathYesstring—

JSON request body

FieldType / allowed valuesRequired
namestringNo
subjectstringNo
blocksobject[]No
textBodystringNo
isDraftbooleanNo
Complete request schema
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    },
    "blocks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "image",
              "heading",
              "text",
              "button",
              "divider"
            ]
          },
          "content": {
            "type": "string"
          },
          "src": {
            "type": "string"
          },
          "href": {
            "type": "string"
          },
          "alt": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "additionalProperties": false
      }
    },
    "textBody": {
      "type": "string"
    },
    "isDraft": {
      "type": "boolean"
    }
  },
  "required": [],
  "additionalProperties": false
}
Responses
  • 200 — Successful response
    Response schema
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true,
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "projectId": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "subject": {
              "type": "string"
            },
            "blocks": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "image",
                      "heading",
                      "text",
                      "button",
                      "divider"
                    ]
                  },
                  "content": {
                    "type": "string"
                  },
                  "src": {
                    "type": "string"
                  },
                  "href": {
                    "type": "string"
                  },
                  "alt": {
                    "type": "string"
                  }
                },
                "required": [
                  "type"
                ],
                "additionalProperties": false
              }
            },
            "textBody": {
              "type": "string"
            },
            "isDraft": {
              "type": "boolean"
            },
            "createdAt": {
              "type": "string",
              "description": "Date string"
            },
            "updatedAt": {
              "type": "string",
              "description": "Date string"
            }
          },
          "required": [
            "id",
            "projectId",
            "name",
            "subject",
            "blocks",
            "textBody",
            "isDraft",
            "createdAt",
            "updatedAt"
          ],
          "additionalProperties": false
        },
        "meta": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            },
            "timestamp": {
              "type": "string"
            }
          },
          "required": [
            "requestId",
            "timestamp"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "ok",
        "data",
        "meta"
      ],
      "additionalProperties": false
    }
    Example response
    {
      "ok": true,
      "data": {
        "id": "string",
        "projectId": "string",
        "name": "string",
        "subject": "string",
        "blocks": [
          {
            "type": "image",
            "content": "string",
            "src": "string",
            "href": "string",
            "alt": "string"
          }
        ],
        "textBody": "string",
        "isDraft": true,
        "createdAt": "string",
        "updatedAt": "string"
      },
      "meta": {
        "requestId": "string",
        "timestamp": "string"
      }
    }

Related guides

Something unclear or out of date? Emailsupport@hubfly.spaceBack to top