From e637d724659d7da412da5a26ef2b9b0fa8754898 Mon Sep 17 00:00:00 2001 From: mantrakp04 Date: Wed, 1 Jul 2026 17:33:28 -0700 Subject: [PATCH] fix(docs): update email sending API description and parameters Enhanced the description for the "/emails/send-email" endpoint to clarify the options for sending emails, including user IDs, all users, and arbitrary email addresses. Additionally, modified the parameters to remove the requirement for "user_id" and added an optional "email" field. --- docs-mintlify/openapi/admin.json | 9 +++++---- docs-mintlify/openapi/server.json | 9 +++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs-mintlify/openapi/admin.json b/docs-mintlify/openapi/admin.json index 01c2681f8..2e1e890eb 100644 --- a/docs-mintlify/openapi/admin.json +++ b/docs-mintlify/openapi/admin.json @@ -2974,7 +2974,7 @@ "/emails/send-email": { "post": { "summary": "Send email", - "description": "Send an email to a list of users. The content field should contain either {html} for HTML emails, {template_id, variables} for template-based emails, or {draft_id} for a draft email.", + "description": "Send an email to a list of users (user_ids), all users (all_users), or arbitrary email addresses (emails). The content field should contain either {html} for HTML emails, {template_id, variables} for template-based emails, or {draft_id} for a draft email.", "parameters": [], "tags": [ "Emails" @@ -2995,11 +2995,12 @@ "properties": { "user_id": { "type": "string" + }, + "email": { + "type": "string" } }, - "required": [ - "user_id" - ] + "required": [] } } }, diff --git a/docs-mintlify/openapi/server.json b/docs-mintlify/openapi/server.json index 3957962cd..d612e83dd 100644 --- a/docs-mintlify/openapi/server.json +++ b/docs-mintlify/openapi/server.json @@ -2934,7 +2934,7 @@ "/emails/send-email": { "post": { "summary": "Send email", - "description": "Send an email to a list of users. The content field should contain either {html} for HTML emails, {template_id, variables} for template-based emails, or {draft_id} for a draft email.", + "description": "Send an email to a list of users (user_ids), all users (all_users), or arbitrary email addresses (emails). The content field should contain either {html} for HTML emails, {template_id, variables} for template-based emails, or {draft_id} for a draft email.", "parameters": [], "tags": [ "Emails" @@ -2955,11 +2955,12 @@ "properties": { "user_id": { "type": "string" + }, + "email": { + "type": "string" } }, - "required": [ - "user_id" - ] + "required": [] } } },