Get my client settings
Returns client settings for the authenticated client.
GET
/
client
/
settings
Get my client settings
curl --request GET \
--url https://api.mailerpath.com/api/v1/client/settings \
--header 'Authorization: <api-key>'import requests
url = "https://api.mailerpath.com/api/v1/client/settings"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.mailerpath.com/api/v1/client/settings', 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://api.mailerpath.com/api/v1/client/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://api.mailerpath.com/api/v1/client/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.mailerpath.com/api/v1/client/settings")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mailerpath.com/api/v1/client/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"afternoon_send_hour": 123,
"afternoon_send_minute": 123,
"ai_advisor_enabled": true,
"auto_approve_enabled": true,
"brand_logo_url": "<string>",
"brand_name": "<string>",
"brand_primary_color": "<string>",
"brand_secondary_color": "<string>",
"client": {
"api_key": "<string>",
"api_key_enabled": true,
"avatar_file": {
"category": "<unknown>",
"created_at": "<string>",
"deleted_at": {
"time": "<string>",
"valid": true
},
"file_size": 123,
"id": 123,
"mime_type": "<string>",
"original_filename": "<string>",
"storage_path": "<string>",
"unique_id": "<string>",
"updated_at": "<string>",
"url": "<string>",
"user_id": 123
},
"avatar_file_id": 123,
"avatar_url": "<string>",
"city": "<string>",
"client_id": "<string>",
"country": "<string>",
"created_at": "<string>",
"current_user_count": 123,
"deleted_at": {
"time": "<string>",
"valid": true
},
"email": "<string>",
"email_verified_at": "<string>",
"first_name": "<string>",
"id": 123,
"is_email_verified": true,
"last_name": "<string>",
"monthly_email_quota": 123,
"monthly_emails_sent": 123,
"phone": "<string>",
"quota_reset_at": "<string>",
"roles": [
{
"created_at": "<string>",
"deleted_at": {
"time": "<string>",
"valid": true
},
"id": 123,
"updated_at": "<string>",
"user_id": 123
}
],
"state": "<string>",
"status": "<unknown>",
"street_address": "<string>",
"subscription_billing_period": "<string>",
"subscription_ends_at": "<string>",
"subscription_plan": {
"created_at": "<string>",
"deleted_at": {
"time": "<string>",
"valid": true
},
"description": "<string>",
"display_order": 123,
"has_advanced_ai_logic": true,
"has_ai_advisor": true,
"has_ai_journey_mapping": true,
"has_core_playbooks": true,
"has_health_monitor": true,
"has_one_click_fixes": true,
"has_priority_growth_support": true,
"has_priority_processing": true,
"has_smart_3_event_setup": true,
"has_unlimited_flows": true,
"id": 123,
"is_active": true,
"max_emails_per_day": 123,
"max_emails_per_month": 123,
"max_users": 123,
"max_workflows": 123,
"name": "<string>",
"price_annually_eur": 123,
"price_monthly_eur": 123,
"updated_at": "<string>"
},
"subscription_plan_id": 123,
"subscription_status": "<string>",
"subscription_tier": "<string>",
"updated_at": "<string>",
"website": "<string>",
"zip_code": "<string>"
},
"client_id": 123,
"company_address": "<string>",
"company_name": "<string>",
"created_at": "<string>",
"custom_email_quota_per_day": 123,
"custom_email_quota_per_month": 123,
"custom_max_workflows": 123,
"deleted_at": {
"time": "<string>",
"valid": true
},
"email_from_address": "<string>",
"email_from_name": "<string>",
"email_reply_to": "<string>",
"email_signature": "<string>",
"enable_critical_bypass": true,
"enabled_workflows": [
123
],
"id": 123,
"max_emails_per_day": 123,
"morning_send_hour": 123,
"morning_send_minute": 123,
"preferences": [
123
],
"queue_timeout_days": 123,
"quiet_hour_end": 123,
"quiet_hour_start": 123,
"send_window_allowed_days": "<string>",
"send_window_enabled": true,
"send_window_end_hour": 123,
"send_window_start_hour": 123,
"timezone": "<string>",
"updated_at": "<string>"
},
"errors": [
{
"condition": "format",
"error": "Invalid email format",
"key": "email"
}
],
"message": "Operation successful",
"meta": {},
"success": true
}{
"data": {},
"errors": [
{
"condition": "format",
"error": "Invalid email format",
"key": "email"
}
],
"message": "Operation successful",
"meta": {},
"success": true
}{
"data": {},
"errors": [
{
"condition": "format",
"error": "Invalid email format",
"key": "email"
}
],
"message": "Operation successful",
"meta": {},
"success": true
}⌘I
Get my client settings
curl --request GET \
--url https://api.mailerpath.com/api/v1/client/settings \
--header 'Authorization: <api-key>'import requests
url = "https://api.mailerpath.com/api/v1/client/settings"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.mailerpath.com/api/v1/client/settings', 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://api.mailerpath.com/api/v1/client/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://api.mailerpath.com/api/v1/client/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.mailerpath.com/api/v1/client/settings")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mailerpath.com/api/v1/client/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"afternoon_send_hour": 123,
"afternoon_send_minute": 123,
"ai_advisor_enabled": true,
"auto_approve_enabled": true,
"brand_logo_url": "<string>",
"brand_name": "<string>",
"brand_primary_color": "<string>",
"brand_secondary_color": "<string>",
"client": {
"api_key": "<string>",
"api_key_enabled": true,
"avatar_file": {
"category": "<unknown>",
"created_at": "<string>",
"deleted_at": {
"time": "<string>",
"valid": true
},
"file_size": 123,
"id": 123,
"mime_type": "<string>",
"original_filename": "<string>",
"storage_path": "<string>",
"unique_id": "<string>",
"updated_at": "<string>",
"url": "<string>",
"user_id": 123
},
"avatar_file_id": 123,
"avatar_url": "<string>",
"city": "<string>",
"client_id": "<string>",
"country": "<string>",
"created_at": "<string>",
"current_user_count": 123,
"deleted_at": {
"time": "<string>",
"valid": true
},
"email": "<string>",
"email_verified_at": "<string>",
"first_name": "<string>",
"id": 123,
"is_email_verified": true,
"last_name": "<string>",
"monthly_email_quota": 123,
"monthly_emails_sent": 123,
"phone": "<string>",
"quota_reset_at": "<string>",
"roles": [
{
"created_at": "<string>",
"deleted_at": {
"time": "<string>",
"valid": true
},
"id": 123,
"updated_at": "<string>",
"user_id": 123
}
],
"state": "<string>",
"status": "<unknown>",
"street_address": "<string>",
"subscription_billing_period": "<string>",
"subscription_ends_at": "<string>",
"subscription_plan": {
"created_at": "<string>",
"deleted_at": {
"time": "<string>",
"valid": true
},
"description": "<string>",
"display_order": 123,
"has_advanced_ai_logic": true,
"has_ai_advisor": true,
"has_ai_journey_mapping": true,
"has_core_playbooks": true,
"has_health_monitor": true,
"has_one_click_fixes": true,
"has_priority_growth_support": true,
"has_priority_processing": true,
"has_smart_3_event_setup": true,
"has_unlimited_flows": true,
"id": 123,
"is_active": true,
"max_emails_per_day": 123,
"max_emails_per_month": 123,
"max_users": 123,
"max_workflows": 123,
"name": "<string>",
"price_annually_eur": 123,
"price_monthly_eur": 123,
"updated_at": "<string>"
},
"subscription_plan_id": 123,
"subscription_status": "<string>",
"subscription_tier": "<string>",
"updated_at": "<string>",
"website": "<string>",
"zip_code": "<string>"
},
"client_id": 123,
"company_address": "<string>",
"company_name": "<string>",
"created_at": "<string>",
"custom_email_quota_per_day": 123,
"custom_email_quota_per_month": 123,
"custom_max_workflows": 123,
"deleted_at": {
"time": "<string>",
"valid": true
},
"email_from_address": "<string>",
"email_from_name": "<string>",
"email_reply_to": "<string>",
"email_signature": "<string>",
"enable_critical_bypass": true,
"enabled_workflows": [
123
],
"id": 123,
"max_emails_per_day": 123,
"morning_send_hour": 123,
"morning_send_minute": 123,
"preferences": [
123
],
"queue_timeout_days": 123,
"quiet_hour_end": 123,
"quiet_hour_start": 123,
"send_window_allowed_days": "<string>",
"send_window_enabled": true,
"send_window_end_hour": 123,
"send_window_start_hour": 123,
"timezone": "<string>",
"updated_at": "<string>"
},
"errors": [
{
"condition": "format",
"error": "Invalid email format",
"key": "email"
}
],
"message": "Operation successful",
"meta": {},
"success": true
}{
"data": {},
"errors": [
{
"condition": "format",
"error": "Invalid email format",
"key": "email"
}
],
"message": "Operation successful",
"meta": {},
"success": true
}{
"data": {},
"errors": [
{
"condition": "format",
"error": "Invalid email format",
"key": "email"
}
],
"message": "Operation successful",
"meta": {},
"success": true
}
