Update unit properties
Updates properties on a given unit
Try this request in your browser
URL
https://connectapi.dial9.co.uk/api/v2/units/update
Access
Must be authenticated as an admin or reseller.
If not authorised, a MustBeAnAdminOrReseller
error will be returned.
Parameters
Parameter | Type | Default |
---|---|---|
unit_id The ID of the unit |
Integer | null |
name The name of the unit |
String | null |
identifier The identifier |
String | null |
wholesale |
null | |
credit_limit The credit limit |
Float | null |
daily_call_cost_limit The total cost of calls per day |
Float | null |
customer_reference This unit's customer reference |
String | null |
call_rate_limit The call rate limit |
Float | null |
call_connect_limit The call connect limit |
Float | null |
credit_warning Whether or not a credit warning should be displayed |
Integer | null |
call_recording_retention_days How many days should call recordings be kept for, leave blank for unlimited |
Integer | null |
free_minutes The number of free minutes available (if overriding a price plan) |
Integer | null |
free_minutes_available The number of free minutes available |
Integer | null |
unit_cost_override The amount to charge for this unit (if different to price plan) |
Float | null |
reseller_cost_override The amount to charge the reseller for this unit (if different to price plan) |
Float | null |
invoice_day The day this unit will usually have an invoice generated |
Integer | null |
renewal_type The type of renewal schedule this unit uses (daily or monthly) |
String | null |
price_plan_id The price plan to assign to this unit |
null |
Errors
Error | Attributes |
---|---|
UnitNotFound The given unit was not found |
|
PricePlanInvalid The price plan provided was invalid. If assigned to a reseller, it must belong to the reseller otherwise it should be global. |
|
NotPermittedToSetUnitCostOverride Must be authenticated as an admin or the unit reseller to set the cost override |
|
NotPermittedToSetResellerCostOverride Must be authenticated as an admin to set the cost override |
|
ValidationError A validation error occurred |
|
Response Data
This action will return a unit structure.
You'll receive all attributes for this structure (basic and extended attributes). You'll receive all expansions for this stucture.