Create Tenant

POST /api/v2/admin/tenants

Create new tenant

cURL

curl --request POST \
  --url https://faisalshop.mvp-apps.ae/api/v2/admin/tenants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Store"
}
'

import requests

url = "https://faisalshop.mvp-apps.ae/api/v2/admin/tenants"

payload = { "name": "My Store" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'My Store'})
};

fetch('https://faisalshop.mvp-apps.ae/api/v2/admin/tenants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://faisalshop.mvp-apps.ae/api/v2/admin/tenants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My Store'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://faisalshop.mvp-apps.ae/api/v2/admin/tenants"

	payload := strings.NewReader("{\n  \"name\": \"My Store\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://faisalshop.mvp-apps.ae/api/v2/admin/tenants")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Store\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://faisalshop.mvp-apps.ae/api/v2/admin/tenants")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My Store\"\n}"

response = http.request(request)
puts response.read_body

201

{
  "id": 123,
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Overview

Create a new tenant (organization). The authenticated user will automatically be added as an ADMIN of the new tenant.

Authorization

• User must be authenticated with a valid Bearer token

Automatic Admin Assignment

When you create a tenant, you are automatically assigned as an ADMIN, giving you full control over the organization.

Example Usage

curl -X POST \
  https://faisalshop.mvp-apps.ae/api/v2/admin/tenants \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My New Store"
  }'

await axios.post(
  '/api/v2/admin/tenants',
  {
    name: 'My New Store'
  },
  {
    headers: {
      Authorization: `Bearer ${token}`
    }
  }
);

Next Steps

After creating a tenant:

1. Add team members using the team member endpoints
2. Create categories for your products
3. Add products to your catalog
4. Configure webhooks for integrations

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name · string · required

Example:

"My Store"

Response

201 - application/json

Tenant created

id · integer

name · string

created_at · string<date-time>