Evo Voice

<back to all web services

PatchAccount

Update the specified account details

Requires Authentication
Required role:SystemAdministrator
The following routes are available for this service:
PATCH/accounts/{accountId}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Accounts;
using Voice.Api;

namespace Voice.Api
{
    public partial class EntityInfo
    {
        ///<summary>
        ///The ID of the object
        ///</summary>
        [ApiMember(Description="The ID of the object")]
        public virtual string Id { get; set; }

        ///<summary>
        ///The date the object was created
        ///</summary>
        [ApiMember(Description="The date the object was created")]
        public virtual string DateCreated { get; set; }

        ///<summary>
        ///The date the object was last modified
        ///</summary>
        [ApiMember(Description="The date the object was last modified")]
        public virtual string DateLastModified { get; set; }

        ///<summary>
        ///The user that created this object
        ///</summary>
        [ApiMember(Description="The user that created this object")]
        public virtual string CreatedBy { get; set; }

        ///<summary>
        ///The user that last modified this object
        ///</summary>
        [ApiMember(Description="The user that last modified this object")]
        public virtual string LastModifiedBy { get; set; }
    }

}

namespace Voice.Api.Accounts
{
    public partial class AccountInfo
        : EntityInfo
    {
        public AccountInfo()
        {
            AncestorIds = new List<string>{};
        }

        ///<summary>
        ///The name of this account
        ///</summary>
        [ApiMember(Description="The name of this account")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The ID of this account's parent
        ///</summary>
        [ApiMember(Description="The ID of this account's parent")]
        public virtual string ParentAccountId { get; set; }

        ///<summary>
        ///The twilio account SID
        ///</summary>
        [ApiMember(Description="The twilio account SID")]
        public virtual string TwilioAccountSid { get; set; }

        ///<summary>
        ///The ancestors of this account. Useful for breadcrumbs
        ///</summary>
        [ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")]
        public virtual List<string> AncestorIds { get; set; }

        ///<summary>
        ///The max number of phone numbers this account can have
        ///</summary>
        [ApiMember(Description="The max number of phone numbers this account can have")]
        public virtual int MaxPhoneNumbers { get; set; }

        ///<summary>
        ///This account is BYOA
        ///</summary>
        [ApiMember(Description="This account is BYOA")]
        public virtual bool IsBYOA { get; set; }

        ///<summary>
        ///TrustHub Profile Sid
        ///</summary>
        [ApiMember(Description="TrustHub Profile Sid")]
        public virtual string TrustHubProfileSid { get; set; }

        ///<summary>
        ///The ID of the logo file
        ///</summary>
        [ApiMember(Description="The ID of the logo file")]
        public virtual string LogoId { get; set; }

        ///<summary>
        ///The URI of the logo file
        ///</summary>
        [ApiMember(Description="The URI of the logo file")]
        public virtual string LogoUri { get; set; }

        ///<summary>
        ///The billing settings for this account
        ///</summary>
        [ApiMember(Description="The billing settings for this account")]
        public virtual BillingSettings BillingSettings { get; set; }
    }

    public partial class BillingItem
    {
        public virtual double BaseCost { get; set; }
        public virtual double RawUnitMultiplier { get; set; }
        public virtual double UnitCost { get; set; }
        public virtual int Allowance { get; set; }
    }

    public partial class BillingSettings
    {
        public virtual BillingItem Base { get; set; }
        public virtual BillingItem LocalNumbers { get; set; }
        public virtual BillingItem TollFreeNumbers { get; set; }
        public virtual BillingItem InboundVoiceCalls { get; set; }
        public virtual BillingItem OutboundVoiceCalls { get; set; }
        public virtual BillingItem InboundFaxes { get; set; }
        public virtual BillingItem OutboundFaxes { get; set; }
        public virtual BillingItem InboundSmsMessages { get; set; }
        public virtual BillingItem OutboundSmsMessages { get; set; }
    }

    ///<summary>
    ///Update the specified account details
    ///</summary>
    [Api(Description="Update the specified account details")]
    public partial class PatchAccount
        : IPatch
    {
        ///<summary>
        ///The ID of the account you want to update
        ///</summary>
        [ApiMember(Description="The ID of the account you want to update")]
        public virtual string AccountId { get; set; }

        ///<summary>
        ///The new name for the account
        ///</summary>
        [ApiMember(Description="The new name for the account")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The max number of phone numbers this account can have
        ///</summary>
        [ApiMember(Description="The max number of phone numbers this account can have")]
        public virtual int? MaxPhoneNumbers { get; set; }

        ///<summary>
        ///The ID of the file to use for a logo on the dashboard
        ///</summary>
        [ApiMember(Description="The ID of the file to use for a logo on the dashboard")]
        public virtual string LogoId { get; set; }

        ///<summary>
        ///Updated billing settings for this account
        ///</summary>
        [ApiMember(Description="Updated billing settings for this account")]
        public virtual BillingSettings BillingSettings { get; set; }
    }

}

C# PatchAccount DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>