Required role: | SystemAdministrator |
PATCH | /accounts/{accountId} |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
/**
* Update the specified account details
*/
@Api(Description="Update the specified account details")
open class PatchAccount : IPatch
{
/**
* The ID of the account you want to update
*/
@ApiMember(Description="The ID of the account you want to update")
var accountId:String? = null
/**
* The new name for the account
*/
@ApiMember(Description="The new name for the account")
var name:String? = null
/**
* The max number of phone numbers this account can have
*/
@ApiMember(Description="The max number of phone numbers this account can have")
var maxPhoneNumbers:Int? = null
/**
* The ID of the file to use for a logo on the dashboard
*/
@ApiMember(Description="The ID of the file to use for a logo on the dashboard")
var logoId:String? = null
/**
* Updated billing settings for this account
*/
@ApiMember(Description="Updated billing settings for this account")
var billingSettings:BillingSettings? = null
}
open class BillingSettings
{
var base:BillingItem? = null
var localNumbers:BillingItem? = null
var tollFreeNumbers:BillingItem? = null
var inboundVoiceCalls:BillingItem? = null
var outboundVoiceCalls:BillingItem? = null
var inboundFaxes:BillingItem? = null
var outboundFaxes:BillingItem? = null
var inboundSmsMessages:BillingItem? = null
var outboundSmsMessages:BillingItem? = null
}
open class BillingItem
{
var baseCost:Double? = null
var rawUnitMultiplier:Double? = null
var unitCost:Double? = null
var allowance:Int? = null
}
open class AccountInfo : EntityInfo()
{
/**
* The name of this account
*/
@ApiMember(Description="The name of this account")
var name:String? = null
/**
* The ID of this account's parent
*/
@ApiMember(Description="The ID of this account's parent")
var parentAccountId:String? = null
/**
* The twilio account SID
*/
@ApiMember(Description="The twilio account SID")
var twilioAccountSid:String? = null
/**
* The ancestors of this account. Useful for breadcrumbs
*/
@ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
var ancestorIds:ArrayList<String> = ArrayList<String>()
/**
* The max number of phone numbers this account can have
*/
@ApiMember(Description="The max number of phone numbers this account can have")
var maxPhoneNumbers:Int? = null
/**
* This account is BYOA
*/
@ApiMember(Description="This account is BYOA")
var isBYOA:Boolean? = null
/**
* TrustHub Profile Sid
*/
@ApiMember(Description="TrustHub Profile Sid")
var trustHubProfileSid:String? = null
/**
* The ID of the logo file
*/
@ApiMember(Description="The ID of the logo file")
var logoId:String? = null
/**
* The URI of the logo file
*/
@ApiMember(Description="The URI of the logo file")
var logoUri:String? = null
/**
* The billing settings for this account
*/
@ApiMember(Description="The billing settings for this account")
var billingSettings:BillingSettings? = null
}
open class EntityInfo
{
/**
* The ID of the object
*/
@ApiMember(Description="The ID of the object")
var id:String? = null
/**
* The date the object was created
*/
@ApiMember(Description="The date the object was created")
var dateCreated:String? = null
/**
* The date the object was last modified
*/
@ApiMember(Description="The date the object was last modified")
var dateLastModified:String? = null
/**
* The user that created this object
*/
@ApiMember(Description="The user that created this object")
var createdBy:String? = null
/**
* The user that last modified this object
*/
@ApiMember(Description="The user that last modified this object")
var lastModifiedBy:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PATCH /accounts/{accountId} HTTP/1.1
Host: evovoice.io
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PatchAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Accounts">
<AccountId>String</AccountId>
<BillingSettings>
<Base>
<Allowance>0</Allowance>
<BaseCost>0</BaseCost>
<RawUnitMultiplier>0</RawUnitMultiplier>
<UnitCost>0</UnitCost>
</Base>
<InboundFaxes>
<Allowance>0</Allowance>
<BaseCost>0</BaseCost>
<RawUnitMultiplier>0</RawUnitMultiplier>
<UnitCost>0</UnitCost>
</InboundFaxes>
<InboundSmsMessages>
<Allowance>0</Allowance>
<BaseCost>0</BaseCost>
<RawUnitMultiplier>0</RawUnitMultiplier>
<UnitCost>0</UnitCost>
</InboundSmsMessages>
<InboundVoiceCalls>
<Allowance>0</Allowance>
<BaseCost>0</BaseCost>
<RawUnitMultiplier>0</RawUnitMultiplier>
<UnitCost>0</UnitCost>
</InboundVoiceCalls>
<LocalNumbers>
<Allowance>0</Allowance>
<BaseCost>0</BaseCost>
<RawUnitMultiplier>0</RawUnitMultiplier>
<UnitCost>0</UnitCost>
</LocalNumbers>
<OutboundFaxes>
<Allowance>0</Allowance>
<BaseCost>0</BaseCost>
<RawUnitMultiplier>0</RawUnitMultiplier>
<UnitCost>0</UnitCost>
</OutboundFaxes>
<OutboundSmsMessages>
<Allowance>0</Allowance>
<BaseCost>0</BaseCost>
<RawUnitMultiplier>0</RawUnitMultiplier>
<UnitCost>0</UnitCost>
</OutboundSmsMessages>
<OutboundVoiceCalls>
<Allowance>0</Allowance>
<BaseCost>0</BaseCost>
<RawUnitMultiplier>0</RawUnitMultiplier>
<UnitCost>0</UnitCost>
</OutboundVoiceCalls>
<TollFreeNumbers>
<Allowance>0</Allowance>
<BaseCost>0</BaseCost>
<RawUnitMultiplier>0</RawUnitMultiplier>
<UnitCost>0</UnitCost>
</TollFreeNumbers>
</BillingSettings>
<LogoId>String</LogoId>
<MaxPhoneNumbers>0</MaxPhoneNumbers>
<Name>String</Name>
</PatchAccount>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AccountInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Accounts"> <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</CreatedBy> <DateCreated xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateCreated> <DateLastModified xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateLastModified> <Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</Id> <LastModifiedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</LastModifiedBy> <AncestorIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>String</d2p1:string> </AncestorIds> <BillingSettings> <Base> <Allowance>0</Allowance> <BaseCost>0</BaseCost> <RawUnitMultiplier>0</RawUnitMultiplier> <UnitCost>0</UnitCost> </Base> <InboundFaxes> <Allowance>0</Allowance> <BaseCost>0</BaseCost> <RawUnitMultiplier>0</RawUnitMultiplier> <UnitCost>0</UnitCost> </InboundFaxes> <InboundSmsMessages> <Allowance>0</Allowance> <BaseCost>0</BaseCost> <RawUnitMultiplier>0</RawUnitMultiplier> <UnitCost>0</UnitCost> </InboundSmsMessages> <InboundVoiceCalls> <Allowance>0</Allowance> <BaseCost>0</BaseCost> <RawUnitMultiplier>0</RawUnitMultiplier> <UnitCost>0</UnitCost> </InboundVoiceCalls> <LocalNumbers> <Allowance>0</Allowance> <BaseCost>0</BaseCost> <RawUnitMultiplier>0</RawUnitMultiplier> <UnitCost>0</UnitCost> </LocalNumbers> <OutboundFaxes> <Allowance>0</Allowance> <BaseCost>0</BaseCost> <RawUnitMultiplier>0</RawUnitMultiplier> <UnitCost>0</UnitCost> </OutboundFaxes> <OutboundSmsMessages> <Allowance>0</Allowance> <BaseCost>0</BaseCost> <RawUnitMultiplier>0</RawUnitMultiplier> <UnitCost>0</UnitCost> </OutboundSmsMessages> <OutboundVoiceCalls> <Allowance>0</Allowance> <BaseCost>0</BaseCost> <RawUnitMultiplier>0</RawUnitMultiplier> <UnitCost>0</UnitCost> </OutboundVoiceCalls> <TollFreeNumbers> <Allowance>0</Allowance> <BaseCost>0</BaseCost> <RawUnitMultiplier>0</RawUnitMultiplier> <UnitCost>0</UnitCost> </TollFreeNumbers> </BillingSettings> <IsBYOA>false</IsBYOA> <LogoId>String</LogoId> <LogoUri>String</LogoUri> <MaxPhoneNumbers>0</MaxPhoneNumbers> <Name>String</Name> <ParentAccountId>String</ParentAccountId> <TrustHubProfileSid>String</TrustHubProfileSid> <TwilioAccountSid>String</TwilioAccountSid> </AccountInfo>