Create a new system domain
post/v1/system_domains/
Request
- Base URLhttps://app.iconik.io/API/auth
- Authnone declared. Required headers: App-ID, Auth-Token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
App-IDstring required
Auth-Tokenstring required
Request body
base_urlstring required
billing_tier'PAYGO' | 'PRO' | 'ENTERPRISE' | 'ENTERPRISE_LEGACY_2025' | 'PRO_LEGACY_2025'
contract_end_datestring date-time nullable
countrystring nullable
creating_user_idstring uuid nullable
custom_termsboolean
date_createdstring date-time
date_modifiedstring date-time
deactivate_datestring date-time nullable
descriptionstring
disable_ai_featuresboolean
disable_billing_pageboolean
disable_cc_purchaseboolean
discount_percentnumber nullable
do_not_charge_edge_transcoderboolean
do_not_charge_remote_proxiesboolean
do_not_charge_shieldboolean
do_not_trace_ai_usageboolean
featuresstring[]
freeze_datestring date-time nullable
has_preloaded_assetsboolean
idstring 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_monthboolean
is_plgboolean
is_templateboolean
licensed_user_billingboolean
marketplace_customer_idstring nullable
marketplace_entitlement_idstring nullable
namestring required
ordway_customer_idstring nullable
ordway_subscription_idstring nullable
platform_namestring
price_liststring nullable
referral_codestring nullable
sales_force_idstring nullable
status'ACTIVE' | 'WARNING' | 'FROZEN' | 'DEACTIVATED'
stripe_idstring nullable
type'TRIAL' | 'CUSTOMER' | 'PARTNER' | 'INTERNAL'
warning_messagestring
Response
Returns a created system domain
base_urlstring required
billing_tier'PAYGO' | 'PRO' | 'ENTERPRISE' | 'ENTERPRISE_LEGACY_2025' | 'PRO_LEGACY_2025'
contract_end_datestring date-time nullable
countrystring nullable
creating_user_idstring uuid nullable
custom_termsboolean
date_createdstring date-time
date_modifiedstring date-time
deactivate_datestring date-time nullable
descriptionstring
disable_ai_featuresboolean
disable_billing_pageboolean
disable_cc_purchaseboolean
discount_percentnumber nullable
do_not_charge_edge_transcoderboolean
do_not_charge_remote_proxiesboolean
do_not_charge_shieldboolean
do_not_trace_ai_usageboolean
featuresstring[]
freeze_datestring date-time nullable
has_preloaded_assetsboolean
idstring 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_monthboolean
is_plgboolean
is_templateboolean
licensed_user_billingboolean
marketplace_customer_idstring nullable
marketplace_entitlement_idstring nullable
namestring required
ordway_customer_idstring nullable
ordway_subscription_idstring nullable
platform_namestring
price_liststring nullable
referral_codestring nullable
sales_force_idstring nullable
status'ACTIVE' | 'WARNING' | 'FROZEN' | 'DEACTIVATED'
stripe_idstring nullable
type'TRIAL' | 'CUSTOMER' | 'PARTNER' | 'INTERNAL'
warning_messagestring
Changes
No recorded changes to this operation across all 1 revision of this API.