Create whitelabel
curl --request POST \
--url https://beta.getsales.io/id/v1/api/whitelabels \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"name": "<string>",
"domain": "<string>",
"logo_url": "<string>",
"icon_url": "<string>",
"login_image_url": "<string>",
"palette": {
"primary_color": "<string>",
"accent_color": "<string>",
"login_background_color": "<string>"
},
"email_from_name": "<string>",
"email_reply_to": "jsmith@example.com",
"email_from_address": "jsmith@example.com"
}
'import requests
url = "https://beta.getsales.io/id/v1/api/whitelabels"
payload = {
"name": "<string>",
"domain": "<string>",
"logo_url": "<string>",
"icon_url": "<string>",
"login_image_url": "<string>",
"palette": {
"primary_color": "<string>",
"accent_color": "<string>",
"login_background_color": "<string>"
},
"email_from_name": "<string>",
"email_reply_to": "jsmith@example.com",
"email_from_address": "jsmith@example.com"
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
domain: '<string>',
logo_url: '<string>',
icon_url: '<string>',
login_image_url: '<string>',
palette: {
primary_color: '<string>',
accent_color: '<string>',
login_background_color: '<string>'
},
email_from_name: '<string>',
email_reply_to: 'jsmith@example.com',
email_from_address: 'jsmith@example.com'
})
};
fetch('https://beta.getsales.io/id/v1/api/whitelabels', 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://beta.getsales.io/id/v1/api/whitelabels",
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' => '<string>',
'domain' => '<string>',
'logo_url' => '<string>',
'icon_url' => '<string>',
'login_image_url' => '<string>',
'palette' => [
'primary_color' => '<string>',
'accent_color' => '<string>',
'login_background_color' => '<string>'
],
'email_from_name' => '<string>',
'email_reply_to' => 'jsmith@example.com',
'email_from_address' => 'jsmith@example.com'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <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://beta.getsales.io/id/v1/api/whitelabels"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"login_image_url\": \"<string>\",\n \"palette\": {\n \"primary_color\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"login_background_color\": \"<string>\"\n },\n \"email_from_name\": \"<string>\",\n \"email_reply_to\": \"jsmith@example.com\",\n \"email_from_address\": \"jsmith@example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<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://beta.getsales.io/id/v1/api/whitelabels")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"login_image_url\": \"<string>\",\n \"palette\": {\n \"primary_color\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"login_background_color\": \"<string>\"\n },\n \"email_from_name\": \"<string>\",\n \"email_reply_to\": \"jsmith@example.com\",\n \"email_from_address\": \"jsmith@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/id/v1/api/whitelabels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"login_image_url\": \"<string>\",\n \"palette\": {\n \"primary_color\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"login_background_color\": \"<string>\"\n },\n \"email_from_name\": \"<string>\",\n \"email_reply_to\": \"jsmith@example.com\",\n \"email_from_address\": \"jsmith@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "create",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"name": "<string>",
"domain": "<string>",
"status": "pending_domain",
"logo_url": "<string>",
"icon_url": "<string>",
"login_image_url": "<string>",
"palette": {
"primary_color": "<string>",
"accent_color": "<string>",
"login_background_color": "<string>"
},
"email_from_name": "<string>",
"email_reply_to": "<string>",
"email_from_address": "<string>",
"email_domain": {
"domain": "<string>",
"status": "pending",
"records": [
{
"type": "<string>",
"host": "<string>",
"value": "<string>",
"valid": true
}
],
"failure_reason": "email_domain_rejected",
"checked_at": "<string>",
"verified_at": "<string>"
},
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"already_exists": true,
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}whitelabels
Create whitelabel
Register a brand on a custom domain, born pending_domain: nothing serves until the reseller points the host’s CNAME at the platform and activate_whitelabel proves it. Needs the White label entitlement on the workspace’s share (403 whitelabel_not_enabled). domain is a bare lowercase FQDN, unique across the platform (409 domain_already_taken; 409 domain_held_by_deleted_whitelabel while a deleted brand still holds it, support releases it); the artwork is given as https URLs (the files are uploaded in the app); the palette is #rrggbb per slot; email_from_name and email_reply_to sign the clients’ mail at once, email_from_address only after verify_whitelabel_email_domain proves its domain. The setup chain: create, hand over the CNAME, activate, poll get_whitelabel with include ssl_certificate until active.
Contract:
- MCP tool
create_whitelabel, registry packagemcp.id/whitelabels, mountid.partner. - Operation
create, response envelopecreate. - Flags: none.
POST
/
api
/
whitelabels
Create whitelabel
curl --request POST \
--url https://beta.getsales.io/id/v1/api/whitelabels \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"name": "<string>",
"domain": "<string>",
"logo_url": "<string>",
"icon_url": "<string>",
"login_image_url": "<string>",
"palette": {
"primary_color": "<string>",
"accent_color": "<string>",
"login_background_color": "<string>"
},
"email_from_name": "<string>",
"email_reply_to": "jsmith@example.com",
"email_from_address": "jsmith@example.com"
}
'import requests
url = "https://beta.getsales.io/id/v1/api/whitelabels"
payload = {
"name": "<string>",
"domain": "<string>",
"logo_url": "<string>",
"icon_url": "<string>",
"login_image_url": "<string>",
"palette": {
"primary_color": "<string>",
"accent_color": "<string>",
"login_background_color": "<string>"
},
"email_from_name": "<string>",
"email_reply_to": "jsmith@example.com",
"email_from_address": "jsmith@example.com"
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
domain: '<string>',
logo_url: '<string>',
icon_url: '<string>',
login_image_url: '<string>',
palette: {
primary_color: '<string>',
accent_color: '<string>',
login_background_color: '<string>'
},
email_from_name: '<string>',
email_reply_to: 'jsmith@example.com',
email_from_address: 'jsmith@example.com'
})
};
fetch('https://beta.getsales.io/id/v1/api/whitelabels', 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://beta.getsales.io/id/v1/api/whitelabels",
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' => '<string>',
'domain' => '<string>',
'logo_url' => '<string>',
'icon_url' => '<string>',
'login_image_url' => '<string>',
'palette' => [
'primary_color' => '<string>',
'accent_color' => '<string>',
'login_background_color' => '<string>'
],
'email_from_name' => '<string>',
'email_reply_to' => 'jsmith@example.com',
'email_from_address' => 'jsmith@example.com'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <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://beta.getsales.io/id/v1/api/whitelabels"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"login_image_url\": \"<string>\",\n \"palette\": {\n \"primary_color\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"login_background_color\": \"<string>\"\n },\n \"email_from_name\": \"<string>\",\n \"email_reply_to\": \"jsmith@example.com\",\n \"email_from_address\": \"jsmith@example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<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://beta.getsales.io/id/v1/api/whitelabels")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"login_image_url\": \"<string>\",\n \"palette\": {\n \"primary_color\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"login_background_color\": \"<string>\"\n },\n \"email_from_name\": \"<string>\",\n \"email_reply_to\": \"jsmith@example.com\",\n \"email_from_address\": \"jsmith@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/id/v1/api/whitelabels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"login_image_url\": \"<string>\",\n \"palette\": {\n \"primary_color\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"login_background_color\": \"<string>\"\n },\n \"email_from_name\": \"<string>\",\n \"email_reply_to\": \"jsmith@example.com\",\n \"email_from_address\": \"jsmith@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "create",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"name": "<string>",
"domain": "<string>",
"status": "pending_domain",
"logo_url": "<string>",
"icon_url": "<string>",
"login_image_url": "<string>",
"palette": {
"primary_color": "<string>",
"accent_color": "<string>",
"login_background_color": "<string>"
},
"email_from_name": "<string>",
"email_reply_to": "<string>",
"email_from_address": "<string>",
"email_domain": {
"domain": "<string>",
"status": "pending",
"records": [
{
"type": "<string>",
"host": "<string>",
"value": "<string>",
"valid": true
}
],
"failure_reason": "email_domain_rejected",
"checked_at": "<string>",
"verified_at": "<string>"
},
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"already_exists": true,
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}Authorizations
Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.
Team scope for tokens that do not carry one. Ignored when the token already names a team.
Body
application/json
Request body of create_whitelabel.
The brand name, 1..255 chars.
Required string length:
1 - 255The app and login host, bare lowercase FQDN (app.reseller.com): no scheme, no path.
Maximum string length:
253Pattern:
^(?=.{1,253}$)([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$https URL of the horizontal logo; null clears it. The file itself is uploaded in the app.
Maximum string length:
2048Pattern:
^https:\/\/https URL of the square mark; null clears it.
Maximum string length:
2048Pattern:
^https:\/\/https URL of the login artwork; null clears it.
Maximum string length:
2048Pattern:
^https:\/\/Brand colors, #rrggbb each; null = the platform defaults.
Show child attributes
Show child attributes
The From name on the clients' mail; null = the brand name.
Maximum string length:
255The Reply-To on the clients' mail; null = none.
Maximum string length:
255The brand's own sender address; refused on a host SendGrid cannot authenticate (422 email_domain_invalid), a platform domain (422 email_domain_reserved) or another team's (409 email_domain_already_taken). Proven by verify_whitelabel_email_domain.
Maximum string length:
255