Company Settings

Update weekly summary email settings (upsert)

Demo-parity mutation for an explicitly allowlisted active or test company. Requires company admin or owner; /qa callers additionally require the test-only QA boundary.

put/companies/{companyId}/weekly-email/settings

Request

  • Base URL: https://api.medianfi.com/api/v1
  • URL: https://api.medianfi.com/api/v1/companies/{companyId}/weekly-email/settings
  • Auth: HTTP bearer

Request body

enabledboolean
cadence'weekly'
sendDay'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'
sendTimestring
timezonestring

IANA time zone, e.g. America/New_York. Rejected with 422 when the zone is unknown.

businessModel'software' | 'services' | 'digital'

Deprecated (#1967): the company's stored business model decides the copy variant; this value is only the fallback when the company model cannot be read or is unset.

introstring nullable
enabledSectionsstring[]

Response

Weekly-email settings updated

Example response

{
  "data": {
    "timezone": "America/New_York"
  }
}

Changes

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