ClientsUpdate client
Clients

Update client

Partially update client fields. Only include the fields you want to change. Returns 400 if no valid fields are provided or validation fails. Returns 404 if client not found.

curl -X PATCH "https://api.mythic-analytics.com/api/v1/clients/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "name": "John Doe",
  "status": true,
  "domain": "example_string",
  "email": "user@example.com",
  "phone": "+1-555-0123",
  "website": "example_string",
  "timezone": "example_string",
  "global_name": "John Doe",
  "company_id": "example_string",
  "agency_id": "example_string",
  "api_metadata": {},
  "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"
  }
}
PATCH
/clients/{id}
PATCH
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
path
idstring
Required

Client identifier. Must match ^[a-zA-Z0-9_-]{1,255}$.

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

The media type of the request body

Options: application/json
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

Path Parameters

idstring
Required

Client identifier. Must match ^[a-zA-Z0-9_-]\{1,255\}$.

Responses

successboolean
dataobject