Onboard a new company
curl --request POST \
--url https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/onboard \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"company": {
"name": "Acme Travel",
"email": "info@acmetravel.com",
"phone": "+971501234567",
"website": "https://acmetravel.com",
"city": "Dubai",
"country": "UAE"
},
"admin_user": {
"email": "admin@acmetravel.com",
"full_name": "John Smith"
},
"region": "middle_east",
"industry": "travel",
"send_welcome_email": true
}
'import requests
url = "https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/onboard"
payload = {
"company": {
"name": "Acme Travel",
"email": "info@acmetravel.com",
"phone": "+971501234567",
"website": "https://acmetravel.com",
"city": "Dubai",
"country": "UAE"
},
"admin_user": {
"email": "admin@acmetravel.com",
"full_name": "John Smith"
},
"region": "middle_east",
"industry": "travel",
"send_welcome_email": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
company: {
name: 'Acme Travel',
email: 'info@acmetravel.com',
phone: '+971501234567',
website: 'https://acmetravel.com',
city: 'Dubai',
country: 'UAE'
},
admin_user: {email: 'admin@acmetravel.com', full_name: 'John Smith'},
region: 'middle_east',
industry: 'travel',
send_welcome_email: true
})
};
fetch('https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/onboard', 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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/onboard",
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([
'company' => [
'name' => 'Acme Travel',
'email' => 'info@acmetravel.com',
'phone' => '+971501234567',
'website' => 'https://acmetravel.com',
'city' => 'Dubai',
'country' => 'UAE'
],
'admin_user' => [
'email' => 'admin@acmetravel.com',
'full_name' => 'John Smith'
],
'region' => 'middle_east',
'industry' => 'travel',
'send_welcome_email' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/onboard"
payload := strings.NewReader("{\n \"company\": {\n \"name\": \"Acme Travel\",\n \"email\": \"info@acmetravel.com\",\n \"phone\": \"+971501234567\",\n \"website\": \"https://acmetravel.com\",\n \"city\": \"Dubai\",\n \"country\": \"UAE\"\n },\n \"admin_user\": {\n \"email\": \"admin@acmetravel.com\",\n \"full_name\": \"John Smith\"\n },\n \"region\": \"middle_east\",\n \"industry\": \"travel\",\n \"send_welcome_email\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/onboard")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"company\": {\n \"name\": \"Acme Travel\",\n \"email\": \"info@acmetravel.com\",\n \"phone\": \"+971501234567\",\n \"website\": \"https://acmetravel.com\",\n \"city\": \"Dubai\",\n \"country\": \"UAE\"\n },\n \"admin_user\": {\n \"email\": \"admin@acmetravel.com\",\n \"full_name\": \"John Smith\"\n },\n \"region\": \"middle_east\",\n \"industry\": \"travel\",\n \"send_welcome_email\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/onboard")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company\": {\n \"name\": \"Acme Travel\",\n \"email\": \"info@acmetravel.com\",\n \"phone\": \"+971501234567\",\n \"website\": \"https://acmetravel.com\",\n \"city\": \"Dubai\",\n \"country\": \"UAE\"\n },\n \"admin_user\": {\n \"email\": \"admin@acmetravel.com\",\n \"full_name\": \"John Smith\"\n },\n \"region\": \"middle_east\",\n \"industry\": \"travel\",\n \"send_welcome_email\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"company": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "<string>",
"region": "middle_east",
"industry": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"admin_user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"full_name": "<string>",
"must_reset_password": true
},
"welcome_email_sent": true,
"defaults_created": {
"deal_statuses": 123,
"lead_statuses": 123,
"activity_types": 123,
"default_branch": true
}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z",
"rate_limit": {
"limit": 123,
"remaining": 123,
"reset": 123
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": {
"fields": {
"first_name": "First name is required"
}
}
},
"meta": {
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2026-02-15T10:00:00.000Z"
}
}{
"success": false,
"error": {
"code": "AUTH_INVALID_KEY",
"message": "Invalid API key"
},
"meta": {
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2026-02-15T10:00:00.000Z"
}
}{
"success": false,
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z",
"rate_limit": {
"limit": 123,
"remaining": 123,
"reset": 123
}
}
}{
"success": false,
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z",
"rate_limit": {
"limit": 123,
"remaining": 123,
"reset": 123
}
}
}{
"success": false,
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Rate limit exceeded. Retry after 12 seconds.",
"details": {
"limit": 60,
"remaining": 0,
"reset": 1718400000000,
"retry_after": 12
}
},
"meta": {
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2026-02-15T10:00:00.000Z"
}
}Onboarding
Onboard a new company
Creates a new company with an admin user, default branch, deal/lead statuses, and activity type configuration. Optionally sends a welcome email.
Required scope: onboarding
POST
/
v1
/
onboard
Onboard a new company
curl --request POST \
--url https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/onboard \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"company": {
"name": "Acme Travel",
"email": "info@acmetravel.com",
"phone": "+971501234567",
"website": "https://acmetravel.com",
"city": "Dubai",
"country": "UAE"
},
"admin_user": {
"email": "admin@acmetravel.com",
"full_name": "John Smith"
},
"region": "middle_east",
"industry": "travel",
"send_welcome_email": true
}
'import requests
url = "https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/onboard"
payload = {
"company": {
"name": "Acme Travel",
"email": "info@acmetravel.com",
"phone": "+971501234567",
"website": "https://acmetravel.com",
"city": "Dubai",
"country": "UAE"
},
"admin_user": {
"email": "admin@acmetravel.com",
"full_name": "John Smith"
},
"region": "middle_east",
"industry": "travel",
"send_welcome_email": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
company: {
name: 'Acme Travel',
email: 'info@acmetravel.com',
phone: '+971501234567',
website: 'https://acmetravel.com',
city: 'Dubai',
country: 'UAE'
},
admin_user: {email: 'admin@acmetravel.com', full_name: 'John Smith'},
region: 'middle_east',
industry: 'travel',
send_welcome_email: true
})
};
fetch('https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/onboard', 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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/onboard",
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([
'company' => [
'name' => 'Acme Travel',
'email' => 'info@acmetravel.com',
'phone' => '+971501234567',
'website' => 'https://acmetravel.com',
'city' => 'Dubai',
'country' => 'UAE'
],
'admin_user' => [
'email' => 'admin@acmetravel.com',
'full_name' => 'John Smith'
],
'region' => 'middle_east',
'industry' => 'travel',
'send_welcome_email' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/onboard"
payload := strings.NewReader("{\n \"company\": {\n \"name\": \"Acme Travel\",\n \"email\": \"info@acmetravel.com\",\n \"phone\": \"+971501234567\",\n \"website\": \"https://acmetravel.com\",\n \"city\": \"Dubai\",\n \"country\": \"UAE\"\n },\n \"admin_user\": {\n \"email\": \"admin@acmetravel.com\",\n \"full_name\": \"John Smith\"\n },\n \"region\": \"middle_east\",\n \"industry\": \"travel\",\n \"send_welcome_email\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/onboard")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"company\": {\n \"name\": \"Acme Travel\",\n \"email\": \"info@acmetravel.com\",\n \"phone\": \"+971501234567\",\n \"website\": \"https://acmetravel.com\",\n \"city\": \"Dubai\",\n \"country\": \"UAE\"\n },\n \"admin_user\": {\n \"email\": \"admin@acmetravel.com\",\n \"full_name\": \"John Smith\"\n },\n \"region\": \"middle_east\",\n \"industry\": \"travel\",\n \"send_welcome_email\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/onboard")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company\": {\n \"name\": \"Acme Travel\",\n \"email\": \"info@acmetravel.com\",\n \"phone\": \"+971501234567\",\n \"website\": \"https://acmetravel.com\",\n \"city\": \"Dubai\",\n \"country\": \"UAE\"\n },\n \"admin_user\": {\n \"email\": \"admin@acmetravel.com\",\n \"full_name\": \"John Smith\"\n },\n \"region\": \"middle_east\",\n \"industry\": \"travel\",\n \"send_welcome_email\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"company": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "<string>",
"region": "middle_east",
"industry": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"admin_user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"full_name": "<string>",
"must_reset_password": true
},
"welcome_email_sent": true,
"defaults_created": {
"deal_statuses": 123,
"lead_statuses": 123,
"activity_types": 123,
"default_branch": true
}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z",
"rate_limit": {
"limit": 123,
"remaining": 123,
"reset": 123
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": {
"fields": {
"first_name": "First name is required"
}
}
},
"meta": {
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2026-02-15T10:00:00.000Z"
}
}{
"success": false,
"error": {
"code": "AUTH_INVALID_KEY",
"message": "Invalid API key"
},
"meta": {
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2026-02-15T10:00:00.000Z"
}
}{
"success": false,
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z",
"rate_limit": {
"limit": 123,
"remaining": 123,
"reset": 123
}
}
}{
"success": false,
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z",
"rate_limit": {
"limit": 123,
"remaining": 123,
"reset": 123
}
}
}{
"success": false,
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Rate limit exceeded. Retry after 12 seconds.",
"details": {
"limit": 60,
"remaining": 0,
"reset": 1718400000000,
"retry_after": 12
}
},
"meta": {
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2026-02-15T10:00:00.000Z"
}
}Authorizations
ApiKeyAuthBearerAuth
API key from Settings > API Keys or POST /v1/api-keys. Format
f9_live_<32 hex chars> (live) or f9_test_<32 hex chars> (sandbox — no
real sends, ever). Legacy wcrm_live_ / wcrm_test_ keys still
authenticate but are no longer issued. Shown once at creation; only a hash
is stored.
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The region the company operates in.
Available options:
middle_east, europe, america The industry the company belongs to (e.g. travel, real-estate, hospitality).
Required string length:
2 - 100