Email

Platform operator only: enable (optionally overriding the daily/monthly quota) or suspend sending for an organization

post/email/sending/operator

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/email/sending/operator
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Request body

organizationIdstring uuid required
enabledboolean required
dailySendLimitinteger

overrides the plan's daily quota for this organization

monthlySendLimitinteger

overrides the plan's monthly quota (migration 138)

Response

Updated

organizationIdstring uuid required
status'not_requested' | 'requested' | 'enabled' | 'suspended' required

enabled: sending is on — automatically once a sending domain of the organization passes its DNS check, on every plan including Free (docs/EMAIL.md "Free tier and quotas"), or by a platform operator; suspended: turned off by a platform operator (a new domain check never turns it back on); not_requested/requested: no sending domain has passed its DNS check yet

dailySendLimitinteger nullable required

the daily quota: recipients per UTC day through POST /emails (to + cc + bcc), from the plan or an operator override; a send that would go over it is refused with rate_limited. null = no quota (the team has no plan limits)

sentTodayinteger required

recipients of today's (UTC) sends counted toward dailySendLimit: POST /emails, plus SMTP relay as the mail server last reported it (see GET /email/usage smtpCounted)

hourlyLimitinteger nullable required

the rolling 60-minute burst guard (a quarter of dailySendLimit): POST /emails refuses a send over it with rate_limited, and the mail server holds SMTP messages over it (held messages are not delivered). null = none

limitResetsAtstring required

next 00:00 UTC, when sentToday starts again from 0

requestedAtstring nullable required

ISO-8601 timestamp

requestMessagestring nullable required
enabledAtstring nullable required

ISO-8601 timestamp

postalServerConfiguredboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.