Settings (automation)
GET
/api/v1/automations/settingsRequest
GET
/api/v1/automations/settingscurl -X GET 'https://app.mailyte.com/api/v1/automations/settings' \
-H 'Authorization: Bearer mk_live_YOUR_API_KEY'const response = await fetch('https://app.mailyte.com/api/v1/automations/settings', {
method: 'GET',
headers: {
Authorization: 'Bearer mk_live_YOUR_API_KEY',
},
});
const { data } = await response.json();import requests
response = requests.get(
"https://app.mailyte.com/api/v1/automations/settings",
headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]<?php
$response = Http::withToken('mk_live_YOUR_API_KEY')
->get('https://app.mailyte.com/api/v1/automations/settings');
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/automations/settings")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Success.
dataobjectmax_marketing_per_dayintegerMarketing emails one contact may receive per local calendar day, across automations and campaigns. Default 2.
max_marketing_per_weekintegerSame, per trailing seven local days. Default 6.
quiet_hours_enabledbooleanquiet_hours_startstringHH:MM in the contact's local time. Automated sends inside quiet hours are held, never dropped.
quiet_hours_endstringsend_window_daysarray<integer>ISO weekdays automated mail may go out on: 1 = Monday … 7 = Sunday.
default_timezonestringUsed for a contact with no timezone attribute of their own.
pause_on_reply_daysintegerReserved: pause a contact's journeys for this many days after they reply.
updated_atstring
Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
401 | The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist. |
403 | The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys. |
404 | No such resource in this organization. |
422 | The request was understood but the values were not acceptable. |
429 | Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait. |
Every status, with what causes it and what to do, is on the error reference.