Skip to main content
POST
/
merchant
/
member
/
new_member
Invite member
curl --request POST \
  --url https://api.unibee.dev/merchant/member/new_member \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "roleIds": [
    123
  ],
  "firstName": "<string>",
  "lastName": "<string>",
  "returnUrl": "<string>"
}
'
{
  "code": 123,
  "data": {},
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

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.
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
emailstringYesThe email of member
firstNamestringNoThe firstName of member
lastNamestringNoThe lastName of member
returnUrlstringNoReturn url of member
roleIdsarrayYesThe id list of role

Request examples

cURL

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

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

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

email
string<string>
required

The email of member

roleIds
integer<int64>[]
required

The id list of role

firstName
string<string>

The firstName of member

lastName
string<string>

The lastName of member

returnUrl
string<string>

Return url of member

Response

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