Skip to content

Create a new employee

Request

Security
ApiKeyAuth
Bodyapplication/jsonrequired
namestringrequired
organization_emailstringrequired
phone_numberstringrequired
team_codestringrequired
rolestringrequired
Value:"CARD USER"
curl -i -X POST \
  https://developer.boyahq.com/_mock/employee/employees \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "organization_email": "string",
    "phone_number": "string",
    "team_code": "string",
    "role": "CARD USER"
  }'

Responses

Created

Bodyapplication/json
idstring
namestring
phonestring
team_codestring
organization_emailstring
rolestring
accnostring

employee wallet accno

balancenumber, (double)

account balance

statusstring
Enum:"ACTIVE""SUSPENDED"
createdAtstring, (date)
Response
{
  "id": "string",
  "name": "string",
  "phone": "string",
  "team_code": "string",
  "organization_email": "string",
  "role": "string",
  "accno": "string",
  "balance": 0.1,
  "status": "ACTIVE",
  "createdAt": "2019-08-24"
}