Skip to main content
POST
/
merchant
/
email
/
gateway_setup_v2
Email Gateway Setup V2(Sendgrid|smtp)
curl --request POST \
  --url https://api.unibee.dev/merchant/email/gateway_setup_v2 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "gatewayName": "<string>",
  "IsDefault": true,
  "apiCredential": {
    "apiKey": "<string>",
    "apiSecret": "<string>",
    "authType": "<string>",
    "oauthToken": "<string>",
    "password": "<string>",
    "skipTLSVerify": true,
    "smtpHost": "<string>",
    "smtpPort": 123,
    "useTLS": true,
    "username": "<string>"
  }
}
'
{
  "code": 123,
  "data": {},
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.unibee.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint Overview

POST https://api.unibee.dev/merchant/email/gateway_setup_v2 Email Gateway Setup V2(Sendgrid|smtp)

​
Authorization

All UniBee Merchant API requests require authentication via API key.
HeaderRequiredDescription
AuthorizationYesBearer <your_api_key>
Content-TypeYesapplication/json (for request body)

​
Parameters

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

​
Request body

NameTypeRequiredDescription
IsDefaultbooleanNoWhether setup the gateway as default or not, default is false
apiCredentialstringNo
gatewayNamestringYesThe name of email gateway, available for sendgrid|smtp

​
Request examples

​
cURL

curl -X POST "https://api.unibee.dev/merchant/email/gateway_setup_v2" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "IsDefault": false,
  "apiCredential": "",
  "gatewayName": ""
}'

​
Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/email/gateway_setup_v2" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "IsDefault": false,
  "apiCredential": "",
  "gatewayName": ""
}'

​
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 statusMeaning
400Bad request — invalid or missing parameters. Check message in the body.
401Unauthorized — missing or invalid API key.
404Not found — invalid path or resource.
500Server 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
​
gatewayName
string<string>
required

The name of email gateway, available for sendgrid|smtp

​
IsDefault
boolean<bool>

Whether setup the gateway as default or not, default is false

​
apiCredential
object

Response

200 - application/json
​
code
integer<int>
​
data
object
​
merchantId
integer<int64>
​
message
string<string>
​
redirect
string<string>
​
requestId
string<string>