mirror of
https://github.com/stack-auth/stack.git
synced 2026-07-20 21:29:36 +08:00
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.
This commit is contained in:
parent
8d124a4517
commit
e637d72465
@ -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": []
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
@ -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": []
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
Loading…
Reference in New Issue
Block a user