Settings (automation)

GET/api/v1/automations/settings
Requires anorganization API keywith the scopeautomations:read

Request

GET/api/v1/automations/settings
curl -X GET 'https://app.mailyte.com/api/v1/automations/settings' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'
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

StatusWhen
401The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
403The 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.
404No such resource in this organization.
422The request was understood but the values were not acceptable.
429Too 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.