Skip to main content

Update Brand Reporting Settings

PUT 
/api/v2/brands/:brand/management-profile

Creates or updates a brand's reporting settings. Every top-level key is optional — omitted keys keep their stored value — so one section can be saved on its own. channels, when sent, replaces the brand's whole channel set.

Required scope: reports:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token (scope: reports, permission: brand_reports.manage).

Body fields:

  • enabled (boolean) — turn scheduled reporting on. Enabling needs at least one report channel and a weekly or monthly cadence.
  • channels[] (array, max 50) — one row per sales channel: sales_channel_id (required, distinct), include_in_report (boolean, default true), competitive_monitoring (boolean, Amazon channels only, default false), marketplace_id (string, optional).
  • competitive_monitoring — "Competition monitoring". Turn it on when other sellers also sell this brand's ASINs: it adds seller/FBA/Prime count history, exact offer totals and an estimated total market per ASIN. Leave it off when you own the brand or distribute it exclusively; MAP, our offer, Amazon retail, Buy Box and sales rank are reported either way.
  • timezone (IANA name) — schedule and week boundaries (Monday–Sunday) use this timezone.
  • weekly.enabled / weekly.day_of_week (1 = Monday … 7 = Sunday) / weekly.time (HH:MM)
  • monthly.enabled / monthly.day_of_month (1–28) / monthly.time (HH:MM)
  • review_required (boolean) — hold each report for review before sending; false sends automatically when the report has no data warnings.
  • map_policy.mode — none | pricing_tier. map_policy.pricing_tier_id is required for pricing_tier. map_policy.tolerance_pct 0–50.
  • watch_mode — auto_top_n | manual | auto_plus_manual. auto_top_n 1–200.
  • brand_aliases[] (max 20) — Amazon brand names that roll into this brand (sub-brands, old names).
  • sections.listing_quality / sections.fba_inventory / sections.products_by_channel (boolean) — optional report sections.
  • delivery.attach_xlsx / attach_pdf / share_link (boolean), delivery.share_link_days (1–365), delivery.cc[] (emails, max 20).
  • sales_drop_threshold_pct (1–100) and sales_drop_min_prior (≥ 0) — when to raise a weekly sales-drop alert.
  • brand_store_url (URL) / brand_store_confirmed_at (date) — manual Brand Store confirmation used by the listing-quality audit.

Saving may start a background watchlist rebuild; its id is returned as watchlist_tracked_job_log_id.

Request​

Responses​

OK

Response Headers
    Content-Type