Update Account API
This document describes the update_account API endpoint for updating an existing account record.
Endpoint
POST /Account/update_account
Request
Request Body
Content-Type: application/json
The request body contains the parameters to update an account record. Below is a detailed table of the account_info parameters:
| Field Name | Type | Description |
|---|---|---|
| activation_date | date | The date on which the account is activated. The date the account is used for the first time. UI equivalent: "Activation date" input field on the Edit Account -> Personal info -> Life cycle panel. |
| address_line_2 | string | The 2nd line of the account owner's address. UI equivalent: "Address, line 2" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| alias_did_number_list | array[object] | The list of the account's aliases' DID numbers. Included in the response if limit_alias_did_number_list parameter is greater than zero. |
| alias_did_number_list.did_number | string | The DID number. Used to specify a phone number. Note: read-only. Possible values: only numbers. |
| alias_did_number_list.i_did_number | integer | The unique ID of the DID number record. Note: read-only. |
| assigned_addons | array[object] | The list of account's add-on products. Note: If the main product is changed and the list of add-on products is not provided, existing add-on products will be removed. UI equivalent: "Select add-on products to add" panel on Edit Account -> Finances -> Add-on products. |
| assigned_addons.addon_effective_from | date-time | Indicates the date when a product add-on is effective. UI equivalent: "Activation date" input field on Edit Account -> Finances -> Add-on products -> %YOUR ADD-ON PRODUCT% -> Additional information panel. |
| assigned_addons.addon_effective_to | date-time | Indicates the date when a product add-on will be ineffective. UI equivalent: "Expiration date" input field on Edit Account -> Finances -> Add-on products -> %YOUR ADD-ON PRODUCT% -> Additional information panel. |
| assigned_addons.addon_priority | integer | Indicates the priority of an add-on product. Possible values: 0 - main product; 10 - low; 15 - medium low; 20 - medium; 25 - medium high; 30 - high. Note: Can only be set on add-on creation and cannot be changed later. UI equivalent: "Priority" input field on the Edit Product main panel. |
| assigned_addons.allowed_products | array[integer] | The list of main products that can be used with the add-on product. UI equivalent: "Add-on product is allowed with" list on Edit Product -> Additional information. |
| assigned_addons.allowed_with_any_product | string | Defines if the add-on product can be assigned with any other main product. Available only for add-on products managed by the administrator and available to resellers. |
| assigned_addons.breakage | number | The breakage. Used to obtain a summary of depleted accounts. UI equivalent: "Breakage, %YOUR_CURRENCY%" input field on the Edit Product -> Charges -> General info main panel. |
| assigned_addons.default_i_acl | integer | Indicates the ACL for accounts with this product assigned. UI equivalent: "Account default ACL" input field on the Edit Product -> Additional information panel. |
| assigned_addons.description | string | The product description. UI equivalent: "Description" input field on the Edit Product -> Additional info panel. |
| assigned_addons.end_user_description | string | The description visible to end users. UI equivalent: "Description visible to end users" input field on the Edit Product -> Additional info panel. |
| assigned_addons.end_user_name | string | The product name visible to end users. UI equivalent: "Name visible to end users" input field on the Edit Product main panel. |
| assigned_addons.fraud_protection | string | The overdraft protection mode for the product. Possible values: None, All, Debit. |
| assigned_addons.hidden | string | Indicates whether the product is hidden. Possible values: Y - is hidden; N - is not hidden. Note: read-only. |
| assigned_addons.i_account_role | integer | The ID of the account role. Possible values: 1 - Universal; 2 - Phone line; 3 - Auto attendant; 4 - Prepaid card; 5 - PINless; 6 - IPv4 address; 7 - User@domain; 8 - MSISDN; 9 - Voucher. UI equivalent: "Account role" input field on the Edit Account main panel. |
| assigned_addons.i_customer | integer | The record ID of the reseller who manages the product. UI equivalent: "Managed by" input field on the Edit Product main panel. |
| assigned_addons.i_product | integer | The unique ID of the product record. |
| assigned_addons.i_product_group | integer | The ID of the product group. UI equivalent: "Product group" input field on the Edit Product -> Additional info panel. |
| assigned_addons.i_reseller_subscription | integer | The ID of the Subscription Plan assigned to the reseller. |
| assigned_addons.i_subscription | integer | The ID of the subscription plan. UI equivalent: "Subscription" input field on the Edit Product -> Charges -> General info -> Subscription -> Subscriptions panel. |
| assigned_addons.i_vd_plan | integer | The ID of the assigned volume discount plan. UI equivalent: "Default discount plan" input field on the Edit Product -> Charges -> General info panel. |
| assigned_addons.included_services | array[integer] | The list of services provided with the product. UI equivalent: List of items on the Edit Product -> Services panel. |
| assigned_addons.info_url | string | The URL to an external website describing product features. UI equivalent: "Information URL" input field on the Edit Product -> Additional info panel. |
| assigned_addons.is_used | integer | Indicates whether the product is used. Possible values: 1 - is used; 0 - is not used. Note: read-only. |
| assigned_addons.is_used_by_resellers | integer | Indicates whether the shared product is used by resellers. Possible values: 1 - is used; 0 - is not used. Note: read-only. |
| assigned_addons.iso_4217 | string | The ISO 4217 code for the currency in which the product is billed. Example: EUR, USD, INR. Note: Cannot be changed after product creation. |
| assigned_addons.managed_by_user | string | Indicates whether the product can be managed by an end user. Possible values: Y - yes; N - no. UI equivalent: "Allow self-care sign-up" switch on the Edit Product -> Additional information panel. |
| assigned_addons.name | string | The product name. UI equivalent: "Name" input field on the Edit Product main panel. |
| assigned_addons.notepad | string | The product notepad for notes. UI equivalent: Input field on the Edit Product -> Additional info Notes panel. |
| assigned_addons.product_group_name | string | The name of the product group. Note: read-only. UI equivalent: "Product group" input field on the Edit Product -> Additional info panel. |
| assigned_addons.product_subscription | object | The product subscription info. UI equivalent: Edit Product -> Charges -> General info -> Subscriptions panel. |
| assigned_addons.product_subscription.activation_fee | number | The one-time fee for subscription activation. Note: read-only. UI equivalent: "Activation fee, %YOUR_CURRENCY%" input field on the Edit Subscription plan -> Fees panel. |
| assigned_addons.product_subscription.activation_mode | integer | The activation mode. Possible values: 1 - at the given start date; 2 - upon the account's first usage. Note: read-only. UI equivalent: "Activation mode" input field on the Create Subscription plan main panel. |
| assigned_addons.product_subscription.advance_periods | integer | The number of periods to charge in advance. Note: read-only. UI equivalent: "Periods in advance" input field on the Edit Subscription plan main panel. |
| assigned_addons.product_subscription.cancel_penalty | number | The cancellation penalty fee. UI equivalent: "Fee, %YOUR_CURRENCY%" input field on the Edit Subscription plan -> Fees panel. |
| assigned_addons.product_subscription.charge_model | integer | Indicates how subscription charges are applied. Possible values: 0 - progressively; 1 - at the end of the billing period; 2 - in advance. Note: read-only. UI equivalent: "Subscription charges applied" input field on the Edit Subscription plan main panel. |
| assigned_addons.product_subscription.description | string | The subscription plan description. Possible length: 255 characters. UI equivalent: "Description" input field on the Edit Subscription plan -> General information panel. |
| assigned_addons.product_subscription.effective_fee | number | The effective subscription fee for the current billing period. |
| assigned_addons.product_subscription.generate_daily_charge | string | Indicates whether to generate daily charges or keep the total charge only. Possible values: Y - generate daily charges; N - keep the total charge only. |
| assigned_addons.product_subscription.i_product | integer | The unique ID of the product record. |
| assigned_addons.product_subscription.i_product_subscription | integer | The unique ID of the product subscription record. |
| assigned_addons.product_subscription.i_subscription | integer | The ID of the subscription plan. |
| assigned_addons.product_subscription.invoice_description | string | The subscription plan name visible to end users on invoices. UI equivalent: "Subscription plan name visible to end users" input field on the Edit Subscription plan main panel. |
| assigned_addons.product_subscription.iso_4217 | string | The ISO 4217 code of the currency for the subscription plan. Example: EUR, USD, INR. Note: Cannot be changed after creation. UI equivalent: "Currency" input field on the Edit Subscription plan main panel. |
| assigned_addons.product_subscription.minimum_period | integer | The minimum subscription period in months. UI equivalent: "Minimum subscription period, months" input field on the Edit Subscription plan -> Fees panel. |
| assigned_addons.product_subscription.multi_month_discount_list | array[object] | Specifies multi-month discounts for subscriptions charged in advance. |
| assigned_addons.product_subscription.multi_month_discount_list.discount_fee | number | The fee with applied discount for the number of months. |
| assigned_addons.product_subscription.multi_month_discount_list.i_subscription | integer | The unique ID of the Subscription Plan record. |
| assigned_addons.product_subscription.multi_month_discount_list.i_subscription_discount | integer | The unique ID of the Subscription Discount record. |
| assigned_addons.product_subscription.multi_month_discount_list.number_of_months | integer | The number of months covered by the discount. |
| assigned_addons.product_subscription.multi_month_discount_list.percent | number | The percentage of the discount for percentage discount type. |
| assigned_addons.product_subscription.multi_month_discount_list.rate | number | The amount of the discount for fixed amount discount type. |
| assigned_addons.product_subscription.multi_month_discount_list.standard_fee | number | The standard fee for the number of months. |
| assigned_addons.product_subscription.multiple | integer | Indicates whether the subscription can be assigned multiple times to one account. Possible values: Y - yes; N - no. Note: read-only. UI equivalent: "Can be applied more than once" input field on the Edit Subscription plan -> General information panel. |
| assigned_addons.product_subscription.name | string | The name of the subscription plan. UI equivalent: "Name" input field on the Edit Subscription plan main panel. |
| assigned_addons.product_subscription.periodic_fees | array[array[object]] | The list of periodic fees for the subscription plan. UI equivalent: "Monthly fee, %YOUR_CURRENCY%" input fields on the Edit Subscription plan -> Fees -> "Adjust periodic fees for non-monthly periods" modal window. |
| assigned_addons.product_subscription.periodic_fees.fee | number | The amount of the fee for one billing period. Note: read-only and inherited from the subscription. UI equivalent: "Periodic fee by usage period" on the Product Info page -> Charges -> General Info -> Subscription panel. |
| assigned_addons.product_subscription.periodic_fees.i_billing_period | integer | The billing period ID the fee is applicable to. Note: read-only and inherited from the subscription. UI equivalent: "Periodic fee by usage period" (label) on the Product Info page -> Charges -> General Info -> Subscription panel. |
| assigned_addons.product_subscription.periodic_fees.i_subscription | integer | The subscription identifier. Note: Changing this field updates all accounts with this product. UI equivalent: "Subscription" on the Product Info page -> Charges -> General Info -> Subscription panel. |
| assigned_addons.product_subscription.periodic_fees.i_subscription_fee | integer | The internal identifier of the billing period subscription fee. Note: read-only and inherited from the subscription. |
| assigned_addons.product_subscription.periodic_fees.periods | integer | The number of billing periods the periodic fee applies to. Note: read-only and inherited from the subscription; 0 means default subscription fee. |
| assigned_addons.product_subscription.rounding | integer | Defines the number of decimal places for rounding charged amounts. Possible values: 1 - min, 5 - max. UI equivalent: "Round up the charged amount, decimal places" input field on the Edit Subscription plan -> Fees panel. |
| assigned_addons.realm | string | The custom string used to impose a scope of uniqueness for account IDs. Note: Cannot be changed for saved products. UI equivalent: "Realm" input field on the Edit Product main panel. |
| assigned_addons.service_features | array[object] | The set of service feature configuration options within the product. UI equivalent: "Service configuration" panel in the Account -> Service section. |
| assigned_addons.service_features.attributes | array[object] | The list of service feature attributes. Note: Both attributes of the cli_trust service feature (accept_caller and supply_caller) are mandatory. |
| assigned_addons.service_features.attributes.effective_values | array[string] | The list of service feature attribute values. Note: read-only; inherited by the account from customer, customer site, or product. Not applicable to products. |
| assigned_addons.service_features.attributes.name | string | The service feature attribute internal name. Note: read-only. |
| assigned_addons.service_features.attributes.values | array[string] | The values of the service attribute. Note: If the attribute accepts a single value, only the first item is checked/populated; applicable only if the feature is overridden on account level. |
| assigned_addons.service_features.defined | integer | Indicates whether the service feature is defined on the object's service features level. Note: If absent, it is always defined on the object's service features level. |
| assigned_addons.service_features.effective_flag_value | string | The actual service feature flag value. Note: read-only; inherited by the account from customer, customer site, or product. |
| assigned_addons.service_features.flag_value | string | The state of the corresponding service feature. Note: Not mandatory for cli_trust and permitted_sip_proxies service features. |
| assigned_addons.service_features.locked | integer | Indicates whether the feature is locked for editing for the current user. Note: If absent, the feature can't be locked. |
| assigned_addons.service_features.locks | array[string] | The list of user types who cannot change service features. Note: If absent, locks are not supported on the object's service features level. |
| assigned_addons.service_features.name | string | The service feature name. |
| assigned_addons.service_flag_locks | string | Specifies whether service feature values can be changed by an administrator or end user. UI equivalent: "Can be edited by" checkbox on Product -> Services -> Choose Service -> Choose any service feature. |
| assigned_addons.shared | string | Indicates whether the product can be shared with resellers. Note: Can be disabled only if not used by resellers; applicable to admin-managed products. UI equivalent: "Share with resellers" input field on the Edit Product main panel. |
| assigned_addons.subscription_discount_list | array[object] | The discount list to encourage multi-month payments. UI equivalent: Item list on the Edit Subscription plan -> Multi-months prepaid plans panel. |
| assigned_addons.subscription_discount_list.discount_fee | number | The discount fee for the prepaid plan. Note: Only for subscriptions charged in advance. UI equivalent: "Discount fee, %YOUR_CURRENCY%" input field on the Subscription plan -> Multi-months prepaid plans. |
| assigned_addons.subscription_discount_list.i_subscription | integer | The unique ID of the subscription plan record. |
| assigned_addons.subscription_discount_list.i_subscription_discount | integer | The unique ID of the subscription discount record. |
| assigned_addons.subscription_discount_list.number_of_months | integer | The number of billing periods for the prepaid plan. Note: Only for subscriptions charged in advance. UI equivalent: "Months" input field on the Subscription plan -> Multi-months prepaid plans. |
| assigned_addons.subscription_discount_list.percent | number | The percentage of the discount for percentage discount type. |
| assigned_addons.subscription_discount_list.rate | number | The amount of the discount for fixed amount discount type. |
| assigned_addons.subscription_discount_list.standard_fee | number | The standard fee for periods without a discount. Note: read-only; used for subscriptions charged in advance. UI equivalent: "Standard fee" input field on the Subscription plan -> Multi-months prepaid plans. |
| assigned_addons.topup_addon | string | Indicates whether the add-on product has a volume discount plan with discounts. Possible values: Y - with discounts; N - without discounts. |
| assigned_addons.volume_discount_plan_name | string | The name of the associated volume discount plan. Note: read-only. UI equivalent: "Name" input field on the Edit Discount plan main panel. |
| aux_fields | array[object] | The data for the account's additional fields. |
| aux_fields.name | string | The name of the additional data field. |
| aux_fields.value | string | The value of the additional data field. |
| baddr1 | string | The 1st line of the account owner's address. UI equivalent: "Address, line 1" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| batch_name | string | The batch name to which the account belongs. Note: A batch belongs to a customer, preventing mixing accounts from different customers. UI equivalent: "Batch" input field on the Edit Account -> Personal info -> General info -> Additional info -> Account info panel. |
| bcc | string | The BCC email address for blind carbon copy. UI equivalent: "BCC" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| bill_status | string | The status of the account. Possible values: O - open; I - inactive; C - terminated. Note: Cannot be set via add_account or update_account; use terminate_account to terminate. |
| billing_model | integer | The account type. Possible values: -1 - debit account; 0 - recharge voucher; 1 - credit account; 2 - alias; 4 - beneficiary. Note: Cannot be changed after creation. UI equivalent: "Type" input field on the Create Account main panel. |
| blocked | string | Indicates whether calls and self-care access are blocked and SIP authorization is enabled. Possible values: Y - blocked; N - not blocked. UI equivalent: "Change status to" input field on the Toolbar -> Change status button. |
| call_processing_mode_info | object | Information about the account's active call processing mode. |
| call_processing_mode_info.effective_from | date-time | The date and time the call processing mode became active. Note: read-only. |
| call_processing_mode_info.effective_to | date-time | The date and time the call processing mode becomes inactive. UI equivalent: "Effective until" field on the Edit Account -> Services -> Call screening -> Modes tab. |
| call_processing_mode_info.i_response_message | integer | The ID of the voice response message. UI equivalent: "Temporary response message" input field on the Edit Account -> Services -> Call screening -> Modes tab. |
| call_processing_mode_info.name | string | The operation mode name. Note: read-only. |
| call_processing_mode_info.response_message_name | string | The response message name. Note: read-only. |
| call_processing_mode_info.short_code | integer | The ID of the operation mode, used as DTMF code to activate the mode. UI equivalent: "Effective mode" field on the Edit Account -> Services -> Call screening -> Modes tab. |
| call_processing_mode_info.sticky | string | Indicates whether the mode can be changed on bulk mode switch. Possible values: Y - preserved; N - changed. Note: read-only. UI equivalent: "Sticky" field on the Edit Account -> Services -> Call screening -> Modes tab. |
| city | string | The city of the account owner's address. UI equivalent: "City" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| companyname | string | The account owner's company name. UI equivalent: "Company name" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| cont1 | string | The main contact person. UI equivalent: "Contact" input field on the Edit Account -> Personal info -> General info panel. |
| cont2 | string | The alternative contact person. UI equivalent: "Alt. contact" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| control_number | integer | The sequential number of the account in the batch. Note: Cannot be changed after creation. UI equivalent: "Control number" input field on the Edit Account -> Personal info -> General info -> Additional info -> Account info panel. |
| country | string | The country code in ISO 3166-1 alpha-2 format. Possible values: 0 - min value; 32 - max value. UI equivalent: "Country" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| credit_limit | number | The account's credit limit value. Note: Only available for credit accounts. UI equivalent: "Credit limit, %YOUR_CURRENCY%" input field on the Edit Account -> Finances -> General info panel. |
| ecommerce_enabled | string | Indicates whether e-commerce is enabled for recharging the account's balance. Possible values: Y - enabled; N - disabled. UI equivalent: "Change status to" input field on the Account Edit -> Personal info -> General info -> Payment method panel. |
| string | The email address associated with the account. UI equivalent: "Email" input field on the Edit Account -> Personal info -> General info panel. | |
| expiration_date | date | The date from which the account becomes unusable. UI equivalent: "Expiration date" input field on the Edit Account -> Personal info -> Life cycle panel. |
| faxnum | string | The account owner's fax number. UI equivalent: "Fax" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| firstname | string | The account owner's first name. UI equivalent: "First name" input field on the Edit Account -> Personal info -> General info panel. |
| h323_password | string | The VoIP password for authenticating calls. UI equivalent: "Service password" input field on the Edit Account -> Personal info -> General info -> Additional info -> Account info panel. |
| i_account | integer | The unique ID of the account. Note: Cannot be changed after creation. |
| i_account_balance_control_type | integer | The ID of the account's balance control type. Possible values: 1 - undefined; 2 - individual credit limit; 3 - subordinate. UI equivalent: "Balance control" input field on the Edit Account main panel. |
| i_account_role | integer | The ID of the account role. Possible values: 1 - Universal; 2 - Phone line; 3 - Auto attendant; 4 - Prepaid card; 5 - PINless; 6 - IPv4 address; 7 - User@domain; 8 - Mobile; 9 - Voucher. UI equivalent: "Account role" input field on the Edit Account main panel. |
| i_acl | integer | The ID for the account's access level. Note: Deprecated; use i_role instead. |
| i_batch | integer | The ID of the batch to which the account belongs. Note: Cannot mix accounts from different customers. |
| i_customer | integer | The ID of the customer record to which the account belongs. Note: Cannot be changed after creation. UI equivalent: "Customer" input field on the Edit Account main panel. |
| i_customer_site | integer | The ID of the customer site the account belongs to. UI equivalent: "Customer site" input field on the Edit Account -> Personal info -> General info -> Additional info -> Account info panel. |
| i_distributor | integer | The unique ID of the distributor associated with the account. Note: Applicable to debit accounts only. |
| i_lang | string | The code for the account's web language. Example: en, ru, es. UI equivalent: "Web interface language" input field on the Edit Account -> Personal info -> General info -> Web self-care panel. |
| i_master_account | integer | The ID of the beneficiary account for alias or sponsor accounts. Note: Can only be updated by the system. UI equivalent: "Sponsor account" field on the Edit Account main panel. |
| i_product | integer | The ID for the account's product. UI equivalent: "Main product" input field on the Edit Account main panel. |
| i_role | integer | The ID of the account's access role. UI equivalent: "Role" input field on the Edit Account -> Personal info -> General info -> Web self-care panel. |
| i_time_zone | integer | The ID for the account's time zone. UI equivalent: "Time zone" input field on the Edit Account -> Personal info -> General info -> Web self-care panel. |
| i_vd_plan | integer | The ID for the account's discount plan. Note: Obsolete; use add-on product functionality instead. UI equivalent: "Discount plan" input field on the Edit Account -> Services -> Bundles panel. |
| id | string | The unique ID (PIN) of the account. Max length: 64 characters. Note: Format depends on the account role. UI equivalent: "ID" input field on the Edit Account main panel. |
| in_date_format | string | The input date format for the self-care interface. UI equivalent: "Date" input field on the Edit Account -> Personal info -> General info -> Web self-care panel -> Input format. |
| in_time_format | string | The input time format for the self-care interface. UI equivalent: "Time" input field on the Edit Account -> Personal info -> General info -> Web self-care panel -> Input format. |
| inactivity_expire_time | integer | The period of account availability after last use. UI equivalent: "Availability period after last usage, days" input field on the Edit Account -> Personal info -> Life cycle panel. |
| included_services | array[object] | The list of services available for the account. Note: Only in "get" responses; ignored in "add"/"update". UI equivalent: Inherited from the account's product and add-ons. |
| included_services.default | string | Indicates whether the service belongs to the system's default set. Possible values: Y - yes; N - no. |
| included_services.dest_group_set_name | string | The destination group set name. Note: read-only; applicable to "service pool" type. UI equivalent: "Destination group set" input field on the Add service panel. |
| included_services.i_dest_group_set | integer | The ID of the destination group set. Note: Applicable to "service pool" type. UI equivalent: "Destination group set" input field on the Add service panel. |
| included_services.i_service | integer | The unique ID of the service record. |
| included_services.i_service_type | integer | The unique ID of the related service type. Possible values: 0 - Internal; 2 - Session based; 3 - Voice calls; 5 - Data service; 6 - Internet access; 7 - Quantity based; 8 - Wi-Fi; 9 - Dial-up internet; 10 - Messaging service; 14 - Conferencing; 15 - DID; 16 - IPTV; 17 - Measured service; 18 - Service pool; 19 - Mobile network provisioning. |
| included_services.i_st_charge_unit | integer | The ID of the service type charge unit. |
| included_services.i_tax_transaction_code | integer | The ID of the tax transaction code for calculating taxes. UI equivalent: "Tax code" input field on the Add service panel. |
| included_services.internal | string | Indicates whether the service is for internal usage. Possible values: Y - yes; N - no. |
| included_services.is_used | integer | Indicates whether the service is used. Possible values: Y - yes; N - no. |
| included_services.name | string | The service name shown on the administrator interface. UI equivalent: "Name" input field on the Edit Service main panel. |
| included_services.rate_unit | string | The customer-visible name for the units used to calculate charges. Max length: 16 characters. UI equivalent: "Billing unit" input field on the Edit Service main panel. |
| included_services.rating_base | string | The billing attribute based on the service type. Note: read-only. UI equivalent: "Rating base" input field on the Edit Service main panel. |
| included_services.ratio | integer | The base ratio defining how many base units make up one billing unit. UI equivalent: "Base ratio" input field on the Edit Service main panel. |
| included_services.service_pool_combination_list | array[object] | The list of combinations for pool services. |
| included_services.service_pool_combination_list.dg_name | string | The destination group name. Note: read-only. UI equivalent: "Destination group" input field on the Add Service main panel. |
| included_services.service_pool_combination_list.i_dest_group | integer | The ID of the destination group. UI equivalent: "Destination group" input field on the Add Service main panel. |
| included_services.service_pool_combination_list.i_service | integer | The ID of the service. UI equivalent: "Service" input field on the Add Service main panel. |
| included_services.service_pool_combination_list.pooled_ratio | integer | The ratio for pooled units. Note: read-only; inherited from the service. |
| included_services.service_pool_combination_list.pooled_unit | string | The pooled unit. Note: read-only; inherited from the service. |
| included_services.service_pool_combination_list.pooled_unit_ratio | string | The ratio for pooled units. |
| included_services.service_pool_combination_list.service_name | string | The service name. Note: read-only; inherited from the service. UI equivalent: "Service" input field on the Add Service main panel. |
| included_services.service_pool_combination_list.unit_ratio | integer | The ratio for service pool units. UI equivalent: "Ratio" input field on the Add Service main panel. |
| included_services.unit | string | The base units for measuring service consumption. Note: Cannot be changed. UI equivalent: "Base unit" input field on the Edit Service main panel. |
| included_services.usage_rating | string | Indicates whether the service is charged according to a rating plan. Possible values: Y - yes; N - no. UI equivalent: "Usage charge" input field on the Edit Service main panel. |
| lastname | string | The account owner's last name. UI equivalent: "Last name" input field on the Edit Account -> Personal info -> General info panel. |
| life_time | integer | The availability period after the first use of the account in days. UI equivalent: "Availability period after first usage, days" field on the Edit Account -> Personal info -> Life cycle panel. |
| login | string | The user login for the self-care web interface. Possible length: 4-64 characters; only digits, letters, @, -, _, and .. UI equivalent: "Login" input field on the Edit Account -> Personal info -> General info -> Web self-care panel. |
| midinit | string | The account owner's middle initial(s). Max length: 25 characters. UI equivalent: "Middle name" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| note | string | A short note about the account's contact details. Max length: 100 characters. UI equivalent: "Description" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| notepad | string | Notes about the account owner. UI equivalent: "Note" input field on the Edit Account -> Personal info -> General info -> Notes panel. |
| opening_balance | number | The initial balance of the account. UI equivalent: "Opening balance" input field on the Create Account main panel. |
| out_date_format | string | The format for the output date on the self-care interface. UI equivalent: "Date" input field on the Edit Account -> Personal info -> General info -> Web self-care panel -> Output format. |
| out_date_time_format | string | The format for the output date and time on the self-care interface. UI equivalent: "Date & time" input field on the Edit Account -> Personal info -> General info -> Web self-care panel -> Output format. |
| out_time_format | string | The format for the output time on the self-care interface. UI equivalent: "Time" input field on the Edit Account -> Personal info -> General info -> Web self-care panel -> Output format. |
| password | string | The user password for the self-care web interface. Min length: 6 characters; must contain at least one letter and one digit. UI equivalent: "Password" input field on the Edit Account -> Personal info -> General info -> Web self-care panel. |
| phone1 | string | The main phone number to contact the end user. UI equivalent: "Phone" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| phone2 | string | The alternative phone number. UI equivalent: "Alt. phone" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| redirect_number | string | The number sent back to the IVR in an authorization confirmation, e.g., redirect to a technical support number. |
| salutation | string | The account owner's salutation. UI equivalent: "Salutation" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| service_features | array[object] | The list of service features. UI equivalent: Item list on the Edit Account -> Services -> Service configuration -> %YOUR_SERVICE% configuration panel. |
| service_features.attributes | array[object] | The list of service feature attributes. Note: Both attributes of the cli_trust service feature (accept_caller and supply_caller) are mandatory. |
| service_features.attributes.effective_values | array[string] | The list of service feature attribute values. Note: read-only; inherited by the account from customer, customer site, or product. Not applicable to products. |
| service_features.attributes.name | string | The service feature attribute internal name. Note: read-only. |
| service_features.attributes.values | array[string] | The values of the service attribute. Note: If the attribute accepts a single value, only the first item is checked/populated; applicable only if overridden on account level. |
| service_features.defined | integer | Indicates whether the service feature is defined on the object's service features level. Note: If absent, it is always defined. |
| service_features.effective_flag_value | string | The actual service feature flag value. Note: read-only; inherited by the account from customer, customer site, or product. |
| service_features.flag_value | string | The state of the corresponding service feature. Note: Not mandatory for cli_trust and permitted_sip_proxies service features. |
| service_features.locked | integer | Indicates whether the feature is locked for editing. Note: If absent, the feature can't be locked. |
| service_features.locks | array[string] | The list of user types who cannot change service features. Note: If absent, locks are not supported. |
| service_features.name | string | The service feature name. |
| sim_card_info | object | Information about a SIM card. |
| sim_card_info.amf | string | The Authentication Management Field. Format: 4-symbol hexadecimal string. UI equivalent: "AMF" input field on the Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.auth_key | string | The Authentication Key. Format: 32-symbol hexadecimal string. UI equivalent: "Authentication key" input field on the Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.description | string | The SIM card description. UI equivalent: "Description" input field on the Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.hlr | string | The name of the Home Location Register database. Format: string. UI equivalent: "HLR" input field on the Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.i_account | integer | The unique ID of the account record to which the SIM card belongs. |
| sim_card_info.i_sim_card | integer | The ID of the SIM card record. |
| sim_card_info.iccid | string | The Integrated Circuit Card ID. Format: 18-22 digit code. UI equivalent: "ICCID" input field on the Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.imsi | string | The International Mobile Subscriber Identity. Format: 6-15 digit string. UI equivalent: "IMSI" input field on the Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.is_used | integer | Indicates whether the SIM card is in use. Possible values: 1 - in use; 0 - available. UI equivalent: SIM Cards list on the Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.managed_by | integer | The ID of the reseller who manages the SIM card. UI equivalent: SIM Cards list on the Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.msisdn | string | The Mobile Subscriber Integrated Services Digital Number. Format: up to 15 digits. UI equivalent: SIM Cards list on the Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.notepad | string | Comments regarding the SIM card. |
| sim_card_info.opc_key | string | The operator key stored on the SIM card. Format: 32-symbol hexadecimal string. UI equivalent: "OPc Key" input field on the Infrastructure -> Inventory -> SIM cards tab. |
| state | string | The province or state where the account owner lives. UI equivalent: "State" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| subscriber_email | string | The subscriber's email address. UI equivalent: "Email for IPTV" input field on the Edit Account -> Personal info -> General info panel. |
| ua_profile_id | integer | The ID for the IP phone profile assigned to the account. |
| voucher_info | object | Information about the voucher used to recharge the account. |
| voucher_info.id | string | The unique ID of the voucher. |
| zip | string | The postal (zip) code. Possible length: 2-10 characters; allows letters, digits, spaces, and dashes. UI equivalent: "Postal code" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| release_assigned_did | integer | Indicates whether the previously assigned DID number should be released to the pool. Possible values: 0 - keep assigned; 1 - release (default). |
Example Request
{
"params": {
"account_info": {
"assigned_addons": [
{
"addon_effective_from": "2022-04-01 00:00:00",
"addon_effective_to": "2022-05-01 00:00:00",
"i_product": 604
}
],
"i_account": 55
}
}
}
Responses
200 OK
The request was successful, and the account record was updated.
| Field Name | Type | Description |
|---|---|---|
| i_account | integer | The unique ID of the created/modified account record. |
Example Response
{
"i_account": 55
}
500 Internal Server Error
An error occurred while processing the request.
| Field Name | Type | Description |
|---|---|---|
| faultcode | string | The error code. |
| faultstring | string | Text description of the error. |