Settings (automation)

PUT/api/v1/automations/settings

Requires anorganization API keywith the scopeautomations:write

Request body

max_marketing_per_dayinteger
The most automated marketing emails one contact may get in a day.
max_marketing_per_weekinteger
The most automated marketing emails one contact may get in a week.
quiet_hours_enabledboolean
Hold automated emails during quiet hours. They are sent when quiet hours end, never dropped.
quiet_hours_startstring
When quiet hours begin, as HH:MM like 21:00, in the contact's own time.
quiet_hours_endstring
When quiet hours end, as HH:MM like 08:00.
send_window_daysarray<integer>
The days automated emails may go out, as numbers: 1 = Monday … 7 = Sunday.
default_timezonestring
The timezone used for a contact with no timezone of their own, as an IANA name like Africa/Lagos.
pause_on_reply_daysinteger
Reserved for pausing a contact's automations after they reply. Saved, but not acted on yet.

Request

PUT/api/v1/automations/settings

curl -X PUT 'https://app.mailyte.com/api/v1/automations/settings' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "max_marketing_per_day": 2,
    "max_marketing_per_week": 5
  }'

const response = await fetch('https://app.mailyte.com/api/v1/automations/settings', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "max_marketing_per_day": 2,
    "max_marketing_per_week": 5
  }),
});
const { data } = await response.json();

import requests
response = requests.put(
    "https://app.mailyte.com/api/v1/automations/settings",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
    json={
      "max_marketing_per_day": 2,
      "max_marketing_per_week": 5
    },
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->put('https://app.mailyte.com/api/v1/automations/settings', [
    'max_marketing_per_day' => 2,
    'max_marketing_per_week' => 5,
]);

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/automations/settings")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
request["Content-Type"] = "application/json"
request.body = {
  "max_marketing_per_day": 2,
  "max_marketing_per_week": 5
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

dataobject
- max_marketing_per_dayinteger
  Marketing emails one contact may receive per local calendar day, across automations and campaigns. Default 2.
- max_marketing_per_weekinteger
  Same, per trailing seven local days. Default 6.
- quiet_hours_enabledboolean
- quiet_hours_startstring
  HH:MM in the contact's local time. Automated sends inside quiet hours are held, never dropped.
- quiet_hours_endstring
- send_window_daysarray<integer>
  ISO weekdays automated mail may go out on: 1 = Monday … 7 = Sunday.
- default_timezonestring
  Used for a contact with no timezone attribute of their own.
- pause_on_reply_daysinteger
  Reserved: 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.