---
title: "Update system domain"
method: PATCH
path: "/v1/system_domains/{system_domain_id}/"
---

# Update system domain

`PATCH /v1/system_domains/{system_domain_id}/`

## Request

- Base URL: `https://app.iconik.io/API/auth`
- URL: `https://app.iconik.io/API/auth/v1/system_domains/{system_domain_id}/`
- Auth: none declared. Required headers: `App-ID`, `Auth-Token`
- TypeScript: <https://skmtc.dev/iconik/apis/iconik-auth/docs/v1/system_domains/:system_domain_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `system_domain_id` string, required

## Headers

- `App-ID` string, required
- `Auth-Token` string, required

## Request body

- SystemDomainSuperAdminSchema
  - `base_url` string, required
  - `billing_limits` BillingLimitsSchema
    - `ai_credits` integer, nullable
    - `ai_object_detection_hours` integer, nullable
    - `automation_tasks` integer, nullable
    - `browse_users` integer, nullable
    - `edge_transcoders` integer, nullable
    - `egress_gb` integer, nullable
    - `face_recognition_hours` integer, nullable
    - `face_recognition_images` integer, nullable
    - `image_recognition` integer, nullable
    - `max_portals` integer, nullable
    - `max_storage_gateway_clusters` integer, nullable
    - `max_storage_gateway_nodes` integer, nullable
    - `multiregion_storage_gb` integer, nullable
    - `power_users` integer, nullable
    - `proxy_storage_gb` integer, nullable
    - `regional_storage_gb` integer, nullable
    - `shield_enabled` boolean, nullable
    - `standard_users` integer, nullable
    - `sync_session_max_clients` integer, nullable
    - `transcription_hours` integer, nullable
  - `billing_tier` 'PAYGO' | 'PRO' | 'ENTERPRISE' | 'ENTERPRISE_LEGACY_2025' | 'PRO_LEGACY_2025'
  - `contract_end_date` string, date-time, nullable
  - `country` string, nullable
  - `creating_user_id` string, uuid, nullable
  - `custom_terms` boolean
  - `date_created` string, date-time
  - `date_modified` string, date-time
  - `deactivate_date` string, date-time, nullable
  - `description` string
  - `disable_ai_features` boolean
  - `disable_billing_page` boolean
  - `disable_cc_purchase` boolean
  - `discount_percent` number, nullable
  - `do_not_charge_edge_transcoder` boolean
  - `do_not_charge_remote_proxies` boolean
  - `do_not_charge_shield` boolean
  - `do_not_trace_ai_usage` boolean
  - `features` string[]
  - `freeze_date` string, date-time, nullable
  - `has_preloaded_assets` boolean
  - `id` string, uuid
  - `industry` 'ADVERTISING_MARKETING_CREATIVE' | 'AUTOMOTIVE' | 'BROADCASTER_NETWORKS' | 'CONSTRUCTION_MANUFACTURING' | 'EDUCATION' | 'ENERGY_UTILITIES' | 'FAITH_RELIGIOUS_ORGS' | 'FINANCE' | 'GAME_STUDIOS_PUBLISHERS' | 'GOVERNMENT_PUBLIC_SECTOR' | 'HEALTHCARE' | 'HOSPITALITY_FITNESS_WELLNESS' | 'LIVE_PRODUCTION_EVENTS' | 'MEDIA_CONGLOMERATES' | 'NONPROFITS_NON_RELIGIOUS' | 'ONLINE_MEDIA' | 'PUBLISHERS_NEWSPAPERS' | 'TELECOMMUNICATIONS' | 'RETAIL_CONSUMER_GOODS' | 'SOFTWARE_TECHNOLOGY' | 'SPORTS_RIGHTS_LEAGUES' | 'STUDIOS_CONTENT_PRODUCERS' | 'OTHER'
  - `invoice_end_of_month` boolean
  - `is_plg` boolean
  - `is_template` boolean
  - `licensed_user_billing` boolean
  - `marketplace_customer_id` string, nullable
  - `marketplace_entitlement_id` string, nullable
  - `name` string, required
  - `ordway_customer_id` string, nullable
  - `ordway_subscription_id` string, nullable
  - `platform_name` string
  - `price_list` string, nullable
  - `referral_code` string, nullable
  - `sales_force_id` string, nullable
  - `status` 'ACTIVE' | 'WARNING' | 'FROZEN' | 'DEACTIVATED'
  - `stripe_id` string, nullable
  - `type` 'TRIAL' | 'CUSTOMER' | 'PARTNER' | 'INTERNAL'
  - `warning_message` string

## Response `200`

Returns an updated system domain

- SystemDomainSuperAdminSchema
  - `base_url` string, required
  - `billing_limits` BillingLimitsSchema
    - `ai_credits` integer, nullable
    - `ai_object_detection_hours` integer, nullable
    - `automation_tasks` integer, nullable
    - `browse_users` integer, nullable
    - `edge_transcoders` integer, nullable
    - `egress_gb` integer, nullable
    - `face_recognition_hours` integer, nullable
    - `face_recognition_images` integer, nullable
    - `image_recognition` integer, nullable
    - `max_portals` integer, nullable
    - `max_storage_gateway_clusters` integer, nullable
    - `max_storage_gateway_nodes` integer, nullable
    - `multiregion_storage_gb` integer, nullable
    - `power_users` integer, nullable
    - `proxy_storage_gb` integer, nullable
    - `regional_storage_gb` integer, nullable
    - `shield_enabled` boolean, nullable
    - `standard_users` integer, nullable
    - `sync_session_max_clients` integer, nullable
    - `transcription_hours` integer, nullable
  - `billing_tier` 'PAYGO' | 'PRO' | 'ENTERPRISE' | 'ENTERPRISE_LEGACY_2025' | 'PRO_LEGACY_2025'
  - `contract_end_date` string, date-time, nullable
  - `country` string, nullable
  - `creating_user_id` string, uuid, nullable
  - `custom_terms` boolean
  - `date_created` string, date-time
  - `date_modified` string, date-time
  - `deactivate_date` string, date-time, nullable
  - `description` string
  - `disable_ai_features` boolean
  - `disable_billing_page` boolean
  - `disable_cc_purchase` boolean
  - `discount_percent` number, nullable
  - `do_not_charge_edge_transcoder` boolean
  - `do_not_charge_remote_proxies` boolean
  - `do_not_charge_shield` boolean
  - `do_not_trace_ai_usage` boolean
  - `features` string[]
  - `freeze_date` string, date-time, nullable
  - `has_preloaded_assets` boolean
  - `id` string, uuid
  - `industry` 'ADVERTISING_MARKETING_CREATIVE' | 'AUTOMOTIVE' | 'BROADCASTER_NETWORKS' | 'CONSTRUCTION_MANUFACTURING' | 'EDUCATION' | 'ENERGY_UTILITIES' | 'FAITH_RELIGIOUS_ORGS' | 'FINANCE' | 'GAME_STUDIOS_PUBLISHERS' | 'GOVERNMENT_PUBLIC_SECTOR' | 'HEALTHCARE' | 'HOSPITALITY_FITNESS_WELLNESS' | 'LIVE_PRODUCTION_EVENTS' | 'MEDIA_CONGLOMERATES' | 'NONPROFITS_NON_RELIGIOUS' | 'ONLINE_MEDIA' | 'PUBLISHERS_NEWSPAPERS' | 'TELECOMMUNICATIONS' | 'RETAIL_CONSUMER_GOODS' | 'SOFTWARE_TECHNOLOGY' | 'SPORTS_RIGHTS_LEAGUES' | 'STUDIOS_CONTENT_PRODUCERS' | 'OTHER'
  - `invoice_end_of_month` boolean
  - `is_plg` boolean
  - `is_template` boolean
  - `licensed_user_billing` boolean
  - `marketplace_customer_id` string, nullable
  - `marketplace_entitlement_id` string, nullable
  - `name` string, required
  - `ordway_customer_id` string, nullable
  - `ordway_subscription_id` string, nullable
  - `platform_name` string
  - `price_list` string, nullable
  - `referral_code` string, nullable
  - `sales_force_id` string, nullable
  - `status` 'ACTIVE' | 'WARNING' | 'FROZEN' | 'DEACTIVATED'
  - `stripe_id` string, nullable
  - `type` 'TRIAL' | 'CUSTOMER' | 'PARTNER' | 'INTERNAL'
  - `warning_message` string

## Other responses

- `400`: Bad request
- `401`: Token is invalid
- `403`: Permission denied
- `404`: System domain does not exist
- `default`: Error response

---

[API](https://skmtc.dev/iconik/apis/iconik-auth.md) - [All operations](https://skmtc.dev/iconik/apis/iconik-auth/llms.txt) - [OpenAPI document](https://skmtc.dev/iconik/apis/iconik-auth/revisions/5dde985bb742?raw)