Send Email Via API Credential

POST /merchant/email/send_email_via_api_credential

Send Email Via API Credential

cURL

curl --request POST \
  --url https://api.unibee.dev/merchant/email/send_email_via_api_credential \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "gatewayName": "<string>",
  "apiCredential": {
    "apiKey": "<string>",
    "apiSecret": "<string>",
    "authType": "<string>",
    "oauthToken": "<string>",
    "password": "<string>",
    "skipTLSVerify": true,
    "smtpHost": "<string>",
    "smtpPort": 123,
    "useTLS": true,
    "username": "<string>"
  },
  "content": "<string>",
  "language": "<string>",
  "subject": "<string>",
  "variables": {}
}
'

200

{
  "code": 123,
  "data": {},
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/email/send_email_via_api_credential

Send Email Via API Credential

---

Authorization

All UniBee Merchant API requests require authentication via API key.

Header	Required	Description
Authorization	Yes	Bearer <your_api_key>
Content-Type	Yes	application/json (for request body)

---

Parameters

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

Request body

Name	Type	Required	Description
apiCredential	string	No
content	string	No
email	string	Yes	Email
gatewayName	string	Yes	The name of email gateway, available for sendgrid|smtp, default gateway will use if not provide
language	string	No	Language
subject	string	No
variables	object	No	Variables，Map

---

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/email/send_email_via_api_credential" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "apiCredential": "",
  "content": "",
  "email": "[e-mail]",
  "gatewayName": "",
  "language": "",
  "subject": "",
  "variables": {}
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/email/send_email_via_api_credential" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "apiCredential": "",
  "content": "",
  "email": "[e-mail]",
  "gatewayName": "",
  "language": "",
  "subject": "",
  "variables": {}
}'

---

Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success. The response schema for this endpoint is shown below.

---

Error handling

HTTP status	Meaning
400	Bad request — invalid or missing parameters. Check message in the body.
401	Unauthorized — missing or invalid API key.
404	Not found — invalid path or resource.
500	Server error — retry with backoff.

When code in the response body is non-zero, check message for details. Use requestId when contacting support.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

email · string<string> · required

Email

gatewayName · string<string> · required

The name of email gateway, available for sendgrid|smtp, default gateway will use if not provide

apiCredential · object

Show child attributes

content · string<string>

language · string<string>

Language

subject · string<string>

variables · object

Variables，Map

Show child attributes

Response

200 - application/json

code · integer<int>

data · object

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>