Create Organization API
Welcome to the documentation for the Create Organization API. This API helps you create an organization.
Base URL
{baseURL}/v1/organizations | POSTRequest Payload
| Field | Type | Source | Required | Description |
|---|---|---|---|---|
| business_name | string | body | ✅ Yes | Name of organization |
| address | string | body | ✅ Yes | Organization address |
| string | body | ✅ Yes | Organization email | |
| first_name | string | body | ✅ Yes | First Name |
| last_name | string | body | ✅ Yes | Last Name |
| phone_number | string | body | ✅ Yes | Organization phone number |
| plan | string | body | ✅ Yes | Plan available |
Sample Request
curl -X POST {baseURL}/v1/organizations \
-H 'Content-Type: application/json' \
-d '{
"business_name": "BOI",
"address": "lagos_nigeria",
"email": "[email protected]",
"first_name": "tunmii",
"last_name": "wilson",
"phone_number": "07031833236",
"plan": "free"
}'Sample 200 Response
{
"message": "Organizations retrieved successfully",
"data": {
"items": [],
"meta": {
"total": 0,
"page": 1,
"limit": 5
}
},
"success": true
}