ClientsCreate client
Clients

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"
}'
{
  "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"
  }
}
POST
/clients
POST
Security Scheme
Bearer Tokenstring
Required

Admin API key as bearer token. Format: Bearer YOUR_ADMIN_KEY

Admin API key as bearer token. Format: Bearer YOUR_ADMIN_KEY
Content-Typestring
Required

The media type of the request body

Options: application/json
idstring
Required

Unique client identifier. Alphanumeric, hyphens, underscores.

Pattern: ^[a-zA-Z0-9_-]{1,255}$
namestring
Required

Human-readable client name.

Min length: 1 • Max length: 255
statusboolean

Whether the client is active.

domainstring

Primary domain for embedded widgets.

emailstring

Contact email.

Format: email
phonestring

Contact phone number.

websitestring

Public website URL.

Format: uri
timezonestring

IANA timezone identifier.

global_namestring

JavaScript identifier for the SDK global variable.

company_idstring

Internal company or reseller identifier.

agency_idstring

Agency identifier for multi-tenant setups.

api_metadataobject

Arbitrary JSON metadata.

ghl_location_idstring

GoHighLevel location identifier.

proxy_api_keystring

Scoped API key for proxying traffic.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Admin API key as bearer token. Format: Bearer YOUR_ADMIN_KEY

Body

application/json
idstring
Required

Unique client identifier. Alphanumeric, hyphens, underscores.

namestring
Required

Human-readable client name.

statusboolean

Whether the client is active.

domainstring

Primary domain for embedded widgets.

emailstring

Contact email.

phonestring

Contact phone number.

websitestring

Public website URL.

timezonestring

IANA timezone identifier.

global_namestring

JavaScript identifier for the SDK global variable.

company_idstring

Internal company or reseller identifier.

agency_idstring

Agency identifier for multi-tenant setups.

api_metadataobject

Arbitrary JSON metadata.

ghl_location_idstring

GoHighLevel location identifier.

proxy_api_keystring

Scoped API key for proxying traffic.

Responses