Create Business User
POST /api/v1/businesses/staff
Description
Create a new business user and send an invitation.
URL:
-
Raw URL:
/api/v1/businesses/staff -
Host:
-
Path:
/api/v1/businesses/staff
Query Parameters:
-
invitedByName: - (Required) Name of the user sending the invitation.
-
invitedByEmail: - (Required) Email of the user sending the invitation.
-
platformLink: - (Required) URL to the platform invitation is sent for.
Response:
- Status: Created (201)
/api/v1/businesses/staff?invitedByName=<string>&invitedByEmail=<string>&platformLink=<string>
Headers
| Content-Type | Value |
|---|---|
| Content-Type | application/json |
Body (raw)
{
"businessId": "<string>",
"role": "BUSINESS_FINANCE",
"username": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"address": "<string>",
"photo": "<string>",
"dob": "<string>",
"gender": "MALE",
"phone": "<string>"
}
Query Params
| Param | value |
|---|---|
| invitedByName | string |
| invitedByEmail | string |
| platformLink | string |
🔑 Authentication bearer
| Param | value | Type |
|---|---|---|
| token | bearerToken | string |
Response: 201
LANGUAGE
CURL REQUEST
curl --request POST \
--url /api/v1/businesses/staff \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!