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

# Invite member

> Will send email to member email provided, member can enter admin portal by email otp login

## Endpoint Overview

**POST** `https://api.unibee.dev/merchant/member/new_member`

Will send email to member email provided, member can enter admin portal by email otp login

***

## 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             |
| ----------- | ------ | -------- | ----------------------- |
| `email`     | string | Yes      | The email of member     |
| `firstName` | string | No       | The firstName of member |
| `lastName`  | string | No       | The lastName of member  |
| `returnUrl` | string | No       | Return url of member    |
| `roleIds`   | array  | Yes      | The id list of role     |

***

## Request examples

### cURL

```bash theme={null}
curl -X POST "https://api.unibee.dev/merchant/member/new_member" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "user@example.com",
  "firstName": "",
  "lastName": "",
  "returnUrl": "https://example.com",
  "roleIds": []
}'
```

### Sandbox

```bash theme={null}
curl -X POST "https://api-sandbox.unibee.top/merchant/member/new_member" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "user@example.com",
  "firstName": "",
  "lastName": "",
  "returnUrl": "https://example.com",
  "roleIds": []
}'
```

***

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


## OpenAPI

````yaml post /merchant/member/new_member
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/member/new_member:
    post:
      tags:
        - Admin Member
      summary: Invite member
      description: >-
        Will send email to member email provided, member can enter admin portal
        by email otp login
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/unibee.api.merchant.member.NewMemberReq'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  code:
                    format: int
                    properties: {}
                    type: integer
                  data:
                    properties: {}
                    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.member.NewMemberReq:
      description: >-
        Will send email to member email provided, member can enter admin portal
        by email otp login
      properties:
        email:
          description: The email of member
          format: string
          properties: {}
          type: string
        firstName:
          description: The firstName of member
          format: string
          properties: {}
          type: string
        lastName:
          description: The lastName of member
          format: string
          properties: {}
          type: string
        returnUrl:
          description: Return url of member
          format: string
          properties: {}
          type: string
        roleIds:
          description: The id list of role
          format: '[]int64'
          items:
            format: int64
            properties: {}
            type: integer
          properties: {}
          type: array
      required:
        - email
        - roleIds
      type: object
  securitySchemes:
    Authorization:
      bearerFormat: JWT
      scheme: bearer
      type: http

````