Create client
Create a new client tenant. The API auto-generates publishable_key and secret_key credentials. Returns 409 Conflict if a client with the same id already exists.
curl -X POST "https://api.mythic-analytics.com/api/v1/clients" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"id": "acme-retail",
"name": "Acme Retail",
"status": true,
"domain": "acme-retail.com",
"email": "ops@acme-retail.com",
"phone": "+1-415-555-0198",
"website": "https://acme-retail.com",
"timezone": "America/Los_Angeles",
"global_name": "acmeRetail",
"company_id": "cmp_7kH3nPqR",
"agency_id": "example_string",
"api_metadata": {
"plan": "enterprise",
"region": "us-west"
},
"ghl_location_id": "example_string",
"proxy_api_key": "example_string"
}'
import requests
import json
url = "https://api.mythic-analytics.com/api/v1/clients"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"id": "acme-retail",
"name": "Acme Retail",
"status": true,
"domain": "acme-retail.com",
"email": "ops@acme-retail.com",
"phone": "+1-415-555-0198",
"website": "https://acme-retail.com",
"timezone": "America/Los_Angeles",
"global_name": "acmeRetail",
"company_id": "cmp_7kH3nPqR",
"agency_id": "example_string",
"api_metadata": {
"plan": "enterprise",
"region": "us-west"
},
"ghl_location_id": "example_string",
"proxy_api_key": "example_string"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.mythic-analytics.com/api/v1/clients", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"id": "acme-retail",
"name": "Acme Retail",
"status": true,
"domain": "acme-retail.com",
"email": "ops@acme-retail.com",
"phone": "+1-415-555-0198",
"website": "https://acme-retail.com",
"timezone": "America/Los_Angeles",
"global_name": "acmeRetail",
"company_id": "cmp_7kH3nPqR",
"agency_id": "example_string",
"api_metadata": {
"plan": "enterprise",
"region": "us-west"
},
"ghl_location_id": "example_string",
"proxy_api_key": "example_string"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"id": "acme-retail",
"name": "Acme Retail",
"status": true,
"domain": "acme-retail.com",
"email": "ops@acme-retail.com",
"phone": "+1-415-555-0198",
"website": "https://acme-retail.com",
"timezone": "America/Los_Angeles",
"global_name": "acmeRetail",
"company_id": "cmp_7kH3nPqR",
"agency_id": "example_string",
"api_metadata": {
"plan": "enterprise",
"region": "us-west"
},
"ghl_location_id": "example_string",
"proxy_api_key": "example_string"
}`)
req, err := http.NewRequest("POST", "https://api.mythic-analytics.com/api/v1/clients", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.mythic-analytics.com/api/v1/clients')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"id": "acme-retail",
"name": "Acme Retail",
"status": true,
"domain": "acme-retail.com",
"email": "ops@acme-retail.com",
"phone": "+1-415-555-0198",
"website": "https://acme-retail.com",
"timezone": "America/Los_Angeles",
"global_name": "acmeRetail",
"company_id": "cmp_7kH3nPqR",
"agency_id": "example_string",
"api_metadata": {
"plan": "enterprise",
"region": "us-west"
},
"ghl_location_id": "example_string",
"proxy_api_key": "example_string"
}'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"id": "acme-retail",
"name": "Acme Retail",
"status": true,
"publishable_key": "pk_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"secret_key": "sk_f6e5d4c3b2a1f6e5d4c3b2a1f6e5d4c3",
"domain": "acme-retail.com",
"email": "ops@acme-retail.com",
"phone": "+1-555-0123",
"website": "example_string",
"timezone": "America/Los_Angeles",
"global_name": "acmeRetail",
"company_id": "cmp_7kH3nPqR",
"agency_id": "example_string",
"api_metadata": {},
"ghl_location_id": "example_string",
"proxy_api_key": "example_string",
"created_at": "2024-03-21T18:42:15.291Z",
"updated_at": "2024-03-21T18:42:15.291Z"
}
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Conflict",
"message": "The request conflicts with the current state of the resource",
"code": 409,
"details": "Resource already exists"
}
/clients
Admin API key as bearer token. Format: Bearer YOUR_ADMIN_KEY
Bearer YOUR_ADMIN_KEYThe media type of the request body
Unique client identifier. Alphanumeric, hyphens, underscores.
Human-readable client name.
Whether the client is active.
Primary domain for embedded widgets.
Contact email.
Contact phone number.
Public website URL.
IANA timezone identifier.
JavaScript identifier for the SDK global variable.
Internal company or reseller identifier.
Agency identifier for multi-tenant setups.
Arbitrary JSON metadata.
GoHighLevel location identifier.
Scoped API key for proxying traffic.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Admin API key as bearer token. Format: Bearer YOUR_ADMIN_KEY
Body
Unique client identifier. Alphanumeric, hyphens, underscores.
Human-readable client name.
Whether the client is active.
Primary domain for embedded widgets.
Contact email.
Contact phone number.
Public website URL.
IANA timezone identifier.
JavaScript identifier for the SDK global variable.
Internal company or reseller identifier.
Agency identifier for multi-tenant setups.
Arbitrary JSON metadata.
GoHighLevel location identifier.
Scoped API key for proxying traffic.
Responses
Last updated today