> ## 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.

# Email Gateway Setup(Sendgrid)

## Endpoint Overview

**POST** `https://api.unibee.dev/merchant/email/gateway_setup`

Email Gateway Setup(Sendgrid)

***

## 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                                                  |
| ------------- | ------- | -------- | ------------------------------------------------------------ |
| `IsDefault`   | boolean | No       | Whether setup the gateway as default or not, default is true |
| `data`        | string  | Yes      | The setup data of email gateway                              |
| `gatewayName` | string  | Yes      | The name of email gateway, available for sendgrid            |

***

## Request examples

### cURL

```bash theme={null}
curl -X POST "https://api.unibee.dev/merchant/email/gateway_setup" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "IsDefault": false,
  "data": "",
  "gatewayName": ""
}'
```

### Sandbox

```bash theme={null}
curl -X POST "https://api-sandbox.unibee.top/merchant/email/gateway_setup" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "IsDefault": false,
  "data": "",
  "gatewayName": ""
}'
```

***

## Response

Success responses return a JSON envelope with `code`, `data`, `message`, `redirect`, and `requestId`. `code` `0` indicates success.

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| `code`      | integer | Response code. `0` = success |
| `data`      | object  | Response payload             |
| `data.data` | string  | The hide star data           |
| `message`   | string  | Human-readable message       |
| `requestId` | string  | Request ID for support       |

***

## 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.


## OpenAPI

````yaml post /merchant/email/gateway_setup
openapi: 3.0.0
info:
  description: UniBee Api Server
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: OpenAPI UniBee
  version: daily,buildtime:202603161017
servers:
  - url: https://api.unibee.dev
  - url: https://api-sandbox.unibee.top
security:
  - Authorization: []
paths:
  /merchant/email/gateway_setup:
    post:
      tags:
        - Email
      summary: Email Gateway Setup(Sendgrid)
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/unibee.api.merchant.email.GatewaySetupReq'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  code:
                    format: int
                    properties: {}
                    type: integer
                  data:
                    properties:
                      data:
                        description: The hide star data
                        format: string
                        properties: {}
                        type: string
                    type: object
                  merchantId:
                    format: int64
                    properties: {}
                    type: integer
                  message:
                    format: string
                    properties: {}
                    type: string
                  redirect:
                    format: string
                    properties: {}
                    type: string
                  requestId:
                    format: string
                    properties: {}
                    type: string
                type: object
          description: ''
components:
  schemas:
    unibee.api.merchant.email.GatewaySetupReq:
      properties:
        IsDefault:
          default: true
          description: Whether setup the gateway as default or not, default is true
          format: bool
          properties: {}
          type: boolean
        data:
          description: The setup data of email gateway
          format: string
          properties: {}
          type: string
        gatewayName:
          description: The name of email gateway, available for sendgrid
          format: string
          properties: {}
          type: string
      required:
        - gatewayName
        - data
      type: object
  securitySchemes:
    Authorization:
      bearerFormat: JWT
      scheme: bearer
      type: http

````