Create a new unit

Creates a new unit by providing the core data need to provision it.

Try this request in your browser

/api/ /units/create

Headers

X-Auth-App
X-Auth-Token
X-Auth-Secret
X-Auth-Extension
X-Auth-Password
X-Proxy-Auth-Token
X-Proxy-Auth-Secret

Parameters

name String
identifier String
wholesale
credit_limit Float
daily_call_cost_limit Float
customer_reference String
call_rate_limit Float
call_connect_limit Float
credit_warning Integer
call_recording_retention_days Integer
free_minutes Integer
free_minutes_available Integer
unit_cost_override Float
reseller_cost_override Float
invoice_day Integer
renewal_type String
price_plan_id
container_id Integer

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/units/create

Access

Must be authenticated as an admin or reseller. If not authorised, a MustBeAnAdminOrReseller error will be returned.

Parameters

Parameter Type Default

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

container_id

The container to assign to this unit. Do not send any ID to auto assign.

Integer null

Errors

Error Attributes

PricePlanInvalid

The price plan provided was invalid. If assigned to a reseller, it must belong to the reseller otherwise it should be global.

  • price_plan_id

    The provided price plan ID

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

  • errors

    An array of errors

ContainerInvalid

The container provided was invalid

  • container_id

    The provided container ID

CannotSelectContainer

A reseller is not permitted to select a container. Do not pass the container_id parameter when authenticated as a reseller.

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.