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"
}'
import requests
import json
url = "https://api.mythic-analytics.com/api/v1/clients/example_string"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"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"
}
response = requests.patch(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.mythic-analytics.com/api/v1/clients/example_string", {
method: "PATCH",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"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"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"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"
}`)
req, err := http.NewRequest("PATCH", "https://api.mythic-analytics.com/api/v1/clients/example_string", 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/example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"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"
}'
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": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
PATCH
/clients/{id}PATCH
Security Scheme
Bearer Tokenstring
RequiredAdmin API key as bearer token. Format: Bearer YOUR_ADMIN_KEY
Admin API key as bearer token. Format:
Bearer YOUR_ADMIN_KEYpath
idstring
RequiredClient identifier. Must match ^[a-zA-Z0-9_-]{1,255}$.
Pattern: ^[a-zA-Z0-9_-]{1,255}$
Content-Typestring
RequiredThe media type of the request body
Options: application/json
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token. Admin API key as bearer token. Format: Bearer YOUR_ADMIN_KEY
Path Parameters
idstring
RequiredClient identifier. Must match ^[a-zA-Z0-9_-]\{1,255\}$.
Body
application/json
Responses
successboolean
dataobject
Was this page helpful?
Built with Documentation.AI
Last updated today