Introduction

The LiveVox Account API provides methods that allow you to retrieve a list of accounts, create and manage an account, find accounts that match specific search criteria, link or unlink Accounts to contacts, and get a list of contacts connected to an account. Multiple contacts can be linked to a single account. Also, you can create and manage account classifications and types.

In addition, you can get a list of accounts associated with the contact. For detailed information on getting a list of accounts associated with the contact, see List Accounts Associated with the Contact method in Contact API.

For a general overview of the LiveVox APIs, include security aspects, see the LiveVox API Overview.

Prerequisites

  • To work with Account APIs, the Account option for your site must be enabled. To verify that the Account option is enabled, from the LiveVox Configuration manager, navigate to the LiveVox Portal > Configure > Client Editor > Billing tab.
  • To obtain a valid Session ID, login into the LiveVox platform. For more information, see Generating a Session ID.
  • To obtain an Access Token used in API requests, you must have an active subscription to the Configuration API. For mor information, see Access Tokens.
  • All messages in this API are subject to rate limits and other restrictions.

User Roles

Unless otherwise specified in this documentation, for a user to be able to access any data through the Account API, the user must belong to either the Sysadmin, Superuser, or Manager role. These roles are defined in the LiveVox Configuration Manager and correspond to users who can access LiveVox configuration data through the LiveVox user interfaces.

API Methods

Account

The Account methods allow you to create and manage accounts in LiveVox. This includes being able to create, read, modify, list, search, and delete accounts.

Create Account

Description:  Creates an account in the Account editor of LiveVox Portal. When creating an account, the system validates against Agent ID, Agent Team ID, Campaign ID, account Classification ID, and account Type ID.

User Roles: Sysadmin or Superuser

Method: POST /account/accounts            

Parameters:

None

Body (JSON):

Key

Type

Mandatory?

Description

name

String

Yes

Name of an Account which can be duplicated.

description

String

No

Description of the account.

industry

String

No

The industry  to which the account belongs.

annualRevenue

Integer

No

Annual revenue of the account.

phoneFax

String

No

Phone or fax number.

billingAddress

Object

No

Billing address.

KeyTypeMandatory?Description
streetStringNoStreet name
cityStringNoCity name
stateStringNoState name
postalCodeStringNoPostal code
countryStringNoCountry name

 

rating

String

No

The account’s prospect rating. For example, Hot, Warm, or Cold.

phoneOffice

String

No

Office phone number.

phoneAlternate

String

No

Alternate phone number.

website

String

No

The website of this account.

ownershipType

String

No

Ownership type for the account. For example, Private, Public, or Subsidiary. 

numOfEmployees

Integer

No

Number of employees. 

tickerSymbol

String

No

The stock ticker symbol for the account.

shippingAddress

String

No

Shipping address

KeyTypeMandatory?Description
streetStringNoStreet name
cityStringNoCity name
stateStringNoState name
postalCodeStringNoPostal Code
countryStringNoCountry name

 

campaignId

String

No

The campaign ID assigned to the account.

accountNumber

String

No

Unique account number assigned to the account within a client.

originalAccountNumber

String

No

Unique account number assigned to the account from originating source, like Salesforce.  

agentId

Integer

No

The agent ID assigned to the account.

agentTeamId

Integer

No

The agent team ID assigned to the account.

accountSource

String

No

The source of the account record. For example, Advertisement, Data.com, or Trade Show. 

sicCodeStringNoStandard Industrial Classification (SIC) code of the account's main business categorization.
sicDescStringNoA brief description of an organization’s line of business, based on its SIC code.

classificationId

Integer

No

The account classification ID.

customFields

Array

No

Custom field values associated with an account.

KeyTypeMandatory?Description
fieldEnumYes

Custom field name where the data will be stored. Valid values are:

  • COL1
  • COL2
  • COL3
  • COL4

...

  • COL99
  • COL100
valueStringYes

The value to place into the customFields.

The max length per custom field is 255 characters.

 

secureFields

Array

No

Secure field values associated with an account.

KeyTypeMandatory?Description
fieldEnumYes

Secure field name where the data will be stored. Valid values are:

  • SECURE1
  • SECURE2

...

  • SECURE5
valueStringYes

The value to place into the secureFields.

If you want to use secureFields, contact the Customer Care team to create a master encryption key.

typeId

Integer

No

The account type ID 

Response Code: 201 Created

Body:

Key

Type

Mandatory?

Description

idIntegerYesThe ID of the newly created account.

Create an Account

#Request (JSON)
Post /account/accounts
Host: localhost.com
Content-Type: application/json
Accept: application/json

{
  "name": "DOC123",
  "description": "Test for Doc",
  "industry": "Software",
  "annualRevenue": "2000",
  "phoneFax": "6503517485",
  "billingAddress": {
    "street": "MG Road",
    "city": "Bangalore",
    "state": "Karnataka",
    "postalCode": "560005",
    "country": "India"
  },
  "rating": "Good",
  "phoneOffice": "9176754178",
  "phoneAlternate": "6178498807 ",
  "website": "www.livevox.com",
  "ownershipType": "Private",
  "numOfEmployees": "450",
  "tickerSymbol": "LV",
  "shippingAddress": {
    "street": "Trinity Circle",
    "city": "Banagalore",
    "state": "Karnataka",
    "postalCode": "560006",
    "country": "India"
  },
  "campaignId": "28571101",
  "accountNumber": "DOC1231",
  "originalAccountNumber": "ONA12",
  "agentId": "595348",
  "agentTeamId": "16001",
  "accountSource": "Advertisement",
  "sicCode": "qa12345678",
  "sicDesc": "qa12345678",
  "classificationId": "172",
  "typeId": "48",
  "customFields": [
    {
      "field": "COL1",
      "value": "15"
    }
  ],
  "secureFields": [
    {
      "field": "SECURE1",
      "value": "TRUE"
    }
  ]
}

#Response
201 Created
Content-Type: application/json

{
    "id": 604423
}
CODE

Create an Account with Account Number that Already Exists

#Request (JSON)
Post /account/accounts
Host: localhost.com
Content-Type: application/json
Accept: application/json

{
  "name": "DOC123",
  "description": "Test for Doc",
  "industry": "Software",
  "annualRevenue": "2000",
  "phoneFax": "6503517485",
  "billingAddress": {
    "street": "MG Road",
    "city": "Bangalore",
    "state": "Karnataka",
    "postalCode": "560005",
    "country": "India"
  },
  "rating": "Good",
  "phoneOffice": "9176754178",
  "phoneAlternate": "6178498807 ",
  "website": "www.livevox.com",
  "ownershipType": "Private",
  "numOfEmployees": "450",
  "tickerSymbol": "LV",
  "shippingAddress": {
    "street": "Trinity Circle",
    "city": "Banagalore",
    "state": "Karnataka",
    "postalCode": "560006",
    "country": "India"
  },
  "campaignId": "28571101",
  "accountNumber": "DOC1231",
  "originalAccountNumber": "ONA12",
  "agentId": "595348",
  "agentTeamId": "16001",
  "accountSource": "Advertisement",
  "sicCode": "qa12345678",
  "sicDesc": "qa12345678",
  "classificationId": "172",
  "typeId": "48",
  "customFields": [
    {
      "field": "COL1",
      "value": "15"
    }
  ],
  "secureFields": [
    {
      "field": "SECURE1",
      "value": "TRUE"
    }
  ]
}

#Response
409 Conflict
Content-Type: application/json

{
    "code": 409,
    "message": "Cannot create account. Unique account number already exists in system."
}
CODE

Create Multiple Accounts

Description:  Creates multiple accounts in the account editor of LiveVox Portal. However, when creating accounts in bulk operations, the system does not validate against Agent ID, Agent Team ID, Campaign ID, account Classification ID, and account Type ID.

User Roles: Sysadmin or Superuser

Method: POST /account/accounts/bulk

Parameters:

None

Body:

KeyTypeMandatory?Description

ArrayNo

A list of accounts to be created. 

KeyTypeMandatory?

Description

name

String

Yes

Name of an Account which can be duplicated.

description

String

No

Description of the account.

industry

String

No

The industry  to which the account belongs.

annualRevenue

Integer

No

Annual revenue of the account.

phoneFax

String

No

Phone or fax number.

billingAddress

String

No

Billing address

KeyTypeMandatory?Description
streetStringNoStreet name
cityStringNoCity name
stateStringNoState name
postalCodeStringNoPostal codes
countryStringNoCountry name

 

rating

String

No

The account’s prospect rating. For example, Hot, Warm, or Cold.

phoneOffice

String

No

Office phone number.

phoneAlternate

String

No

Alternate phone number.

website

String

No

The website of this account.

ownershipType

String

No

Ownership type for the account. For example, Private, Public, or Subsidiary. 

numOfEmployees

Integer

No

Number of employees. 

tickerSymbol

String

No

The stock ticker symbol for the account.

shippingAddress

String

No

Shipping address

KeyTypeMandatory?Description
streetStringNoStreet name
cityStringNoCity name
stateStringNoState name
postalCodeStringNoPostal code
countryStringNoCountry name

 

campaignId

String

No

The campaign ID assigned to the account.

accountNumber

String

No

Unique account number assigned to the account within a client.

originalAccountNumber

String

No

Unique account number assigned to the account from originating source, like Salesforce.

agentId

Integer

No

The agent ID assigned to the account.

agentTeamId

Integer

No

The agent team ID assigned to the account.

accountSource

String

No

The source of the account record. For example, Advertisement, Data.com, or Trade Show. 

sicCodeStringNoStandard Industrial Classification (SIC) code of the account's main business categorization.
sicDescStringNoA brief description of an organization’s line of business, based on its SIC code.

classificationId

Integer

No

The account classification ID.

customFields

Array

No

Custom field values associated to an account.

KeyTypeMandatory?Description
fieldEnumYes

Custom field name where the data will be stored. Valid values are:

  • COL1
  • COL2

...

  • COL100
valueStringYes

The value to place into the custom field.

The max length per custom field is 255 characters.

 

secureFields

Array

No

Secure field values associated with an account.

KeyTypeMandatory?Description
fieldEnumYes

Secure field name where the data will be stored. Valid values are:

  • SECURE1
  • SECURE2

...

  • SECURE5
valueStringYes

The value to place into the secure field.

If you want to use secureFields, contact the Customer Care team to create a master encryption key.

typeId

Integer

No

The ID of the account type.

Response Code: 200 OK

Body:

KeyTypeMandatory?Description
successCountIntegerYesThe number of accounts created.
updateCountIntegerYesThe number of accounts updated.
failCountIntegerYesThe number of accounts not created.
failedDataArrayNo

A list of failed data

KeyTypeMandatory?Description

data

Array

no

Failed account data

KeyTypeMandatory?Description
createdByStringNoThe username who created the account.
clientIdIntegerNoThe client ID.
name

String

No

Name of an Account.

description

String

No

Description of the account
accountNumber

String

No

Unique account number assigned to the account within a client.

originalAccountNumber

String

No

Unique account number assigned to the account from originating source, like Salesforce.

ordinalIntegerYesIndicates the position of the account.
statusStringYesError status.

Create Multiple Accounts

#Request (JSON)
Post /account/accounts
Host: localhost.com
Content-Type: application/json   

[
  {
    "name": "kavita9779",
    "description": "kavita07",
    "billingAddress": {
      "street": "Bangalore_1",
      "city": "Bangalore",
      "state": "KA",
      "postalCode": "560001",
      "country": "INDIA"
    },
    "originalAccountNumber": "kav121",
    "accountNumber": "kav12341111"
  },
  {
    "name": "kavita9999",
    "description": "kavita05",
    "billingAddress": {
      "street": "Bangalore_1",
      "city": "Bangalore",
      "state": "KA",
      "postalCode": "560001",
      "country": "INDIA"
    },
    "accountNumber": "kav121331",
    "originalAccountNumber": "kav1112"
  }
]   

#Response
200 OK
Content-Type: application/json   

{
  "failCount": 1,
  "failedData": [
    {
      "data": {
        "createdBy": "apiSysAdmin",
        "clientId": 94572,
        "name": "kavita9779",
        "description": "kavita07",
        "accountNumber": "kav12341111",
        "originalAccountNumber": "kav121"
      },
      "ordinal": 1,
      "status": "Internal Server Error"
    }
  ],
  "successCount": 1,
  "updateCount": 0
}
CODE

Read Account 

Description: Retrieves information about a specific account. 

User Roles: Sysadmin, Superuser, or Manager

Method: GET /account/accounts/{id}

Parameters:

Path/Query Parameter Name

Type

Mandatory?

Description

idIntegerYesAccount ID to be read.

Body:

None

Response Code: 200 OK

Body:

KeyTypeMandatory?Description

id

Integer

Yes

Account ID.

createdDateDateYesThe creation date of the account (Unix timestamp format).
createdByStringYesThe username who created the account.
modifiedDateDateYesThe most recent modification date of the account (Unix timestamp format).
modifiedByStringYesThe username who last modified the account.

name

String

Yes

Account name. 

description

String

No

Description of the account.

industry

String

No

Industry to which the account belongs.

annualRevenue

Integer

No

Annual revenue of the account.

phoneFax

String

No

Phone or fax number.

billingAddress

String

No

Billing address

KeyTypeMandatory?Description
streetStringNoStreet name
cityStringNoCity name
stateStringNoState name
postalCodeStringNoPostal code
countryStringNoCountry name

rating

String

No

The account’s prospect rating. For example, Hot, Warm, or Cold.

phoneOffice

String

No

Office phone number.

phoneAlternate

String

No

Alternative phone number.

website

String

No

The website for this account.

ownershipType

String

No

Ownership type for the account. For example, Private, Public, or Subsidiary. 

numOfEmployees

Integer

No

Number of employees. 

tickerSymbol

String

No

The stock ticker symbol for the account.

shippingAddress

String

No

Shipping address.

KeyTypeMandatory?Description
streetStringNoStreet name
cityStringNoCity name
stateStringNoState name
postalCodeStringNoPostal code
countryStringNoCountry name

campaignId

String

No

The ID of a campaign assigned to the account.

accountNumber

String

No

Unique account number assigned to the account within a client.

originalAccountNumber

String

No

Unique account number assigned to the account from the originating source, such as Salesforce.  

agentId

Integer

No

The ID of the agent assigned to the account.

agentTeamId

Integer

No

The ID of the agent team assigned to the account.

accountSource

String

No

The source of the account record. For example, Advertisement, Data.com, or Trade Show.

sicCodeStringNoStandard Industrial Classification (SIC) code of the account's main business categorization.
sicDescStringNoA brief description of an organization’s line of business, based on its SIC code.

classificationId

Integer

No

The account classification ID.

customFields

Array

No

Custom field values associated to an account.

KeyTypeMandatory?Description
fieldEnumYes

Custom field name where the data is stored. Valid values are:

  • COL1
  • COL2
  • COL3
  • COL4

...

  • COL99
  • COL100
valueStringYes

The value to place into the custom field.

The max length per custom field is 255 characters.

secureFields

Array

No

Secure field values associated with an account.

KeyTypeMandatory?Description
fieldEnumYes

Secure field name where the data will be stored. Valid values are:

  • SECURE1
  • SECURE2

...

  • SECURE5
valueStringYes

The value to place into the secure field.

typeId

Integer

No

The account type ID. 

notes

Array

No

A list of notes associated with the account.

KeyTypeMandatory?Description
nameStringNoNote name
descriptionStringNoDescription

contacts

Array

No

 A list of contact IDs associated with the account. Contact IDs are unique IDs to identify contacts in Contact Manager, where they are also called accounts.

classificationName

String

No

The account classification name.

typeName

String

No

The account type name.

agentName

String

No

Name of the agent assigned to the account.

history

Object

No

The account history

KeyTypeMandatory?Description
clientIdIntegerNoClient ID of the history record.
createdByStringNoThe username who created the history record.
createdDateDateNoCreation date of the history record.
descriptionsString NoDescription of the changes.
idIntegerNoPrimary key for the history record.
nameStringNoName of the history record.
parentTypeENUMNoType of record being updated. It can be one of the following values: ACCOUNT, NOTE, VIEW, TICKET, OPPORTUNITY, LEAD, AGENT, USER, CONTACT, COMMENT.
parentIdIntegerNoID associated with the parentType record.

 

primaryAccountContact

String

No

Primary account value.

logId

UUID

No

Error ID.

errorMsg

String

No

Error Description.

primaryContact

Object

No

Primary contact information

KeyTypeMandatory?Description
idIntegerNoPrimary Key for the contact record.
createdDateDateNoCreation date of the contact record.
createdByStringNoName of the user who created the contact record.
modifiedDateDateNoModification date of the contact record.
modifiedByStringNoName of the user who modified the contact record.
contactStringNoName of the contact record.
accountIdIntegerNoID for the account record that is associated with the contact.
originalAccountIdStringNoUnique account number assigned to the account from the originating source. For example, Salesforce. Used to fetch the accountId only.

 

agentTeamName

String

No

Name of the agent team assigned to the account.

Read an Account

#Request (JSON)
GET /account/accounts/607260 
Host: localhost.com
Content-Type: application/json

#Response
200 OK
Content-Type: application/json  

{
  "id": 607260,
  "createdDate": 1672638331042,
  "createdBy": "apiSysAdmin",
  "modifiedDate": 1691097856355,
  "modifiedBy": "apiSysAdmin",
  "clientId": 84723,
  "name": "QA11690867366153",
  "description": "QAE11690867366153",
  "industry": "API11690867366153",
  "annualRevenue": 100,
  "phoneFax": "+16503510000",
  "rating": "Hot",
  "phoneOffice": "+16503517000",
  "phoneAlternate": "+16503517400",
  "website": "www.livevox.com",
  "tickerSymbol": "LV",
  "sicCode": "qa12345678",
  "campaignId": "120690619",
  "number": 101,
  "accountNumber": "qa12344",
  "originalAccountNumber": "OAN12",
  "agentId": 561754,
  "agentTeamId": 15581,
  "primaryContact": 102927,
  "accountSource": "Advertisement",
  "sicDesc": "qa1234567",
  "errorMsg": "ERROR_CCSFEATURES_ENCRYPTED_FALSE: Can't display secure fields due to misconfiguration.",
  "logId": "8d4efcc0-73dc-40e1-8c3e-4c3f8dad741b",
  "notes": [],
  "contacts": [
    {
      "id": 102927,
      "createdDate": 1672638392601,
      "createdBy": "apiSysAdmin",
      "modifiedDate": 1672638392601,
      "contact": "qa123",
      "accountId": 607260
    }
  ],
  "history": [],
  "primaryAccountContact": {
    "id": 102927,
    "createdDate": 1672638392601,
    "createdBy": "apiSysAdmin",
    "modifiedDate": 1672638392601,
    "contact": "qa123",
    "accountId": 607260
  },
  "agentTeamName": "apiteam",
  "billingAddress": {
    "street": "Bangalore_1",
    "city": "Bangalore",
    "state": "KA",
    "postalCode": "560001",
    "country": "INDIA"
  },
  "shippingAddress": {
    "street": "Bangalore_2",
    "city": "KA2",
    "postalCode": "560001",
    "country": "IND"
  }
}
CODE

List Accounts

Description:  Retrieves information about accounts based on the provided offset and count (number of items) values 

User Roles: Sysadmin, Superuser, or Manager

Method: GET /account/accounts?count={n}&offset={n}

Parameters:

Path/Query Parameter Name

Variable Name

Type

Mandatory?

Description

countnIntegerYesSpecifies the number of items to return in the list. There is a maximum of 1000 items.
offsetnIntegerYesRequired for pagination. Specifies the offset from 0, based on the count, to start listing from.

Body:

None

Response Code: 200 Ok

Body:

KeyTypeMandatory?Description
nextURINoA Uniform Resource Identifier (URI) for the next page of entries. If next is not present, or blank, then there are no pages after this one.
listAccountsArrayNo

A list of accounts.

The list is sorted by name.

KeyTypeMandatory?Description

id

Integer

Yes

Account ID.

createdDateDateYesThe creation date of the account (Unix timestamp format).
createdByStringYesThe username who created the account.
modifiedDateDateYesThe most recent modification date of the account  (Unix timestamp format).
modifiedByStringYesThe username who last modified the account.

name

String

Yes

Account name. 

description

String

No

Description of the account.

industry

String

No

The industry to which the account belongs.

annualRevenue

Integer

No

Annual revenue of the account.

phoneFax

String

No

Phone or fax number.

billingAddress

String

No

Billing address

KeyTypeMandatory?Description
streetStringNoStreet name
cityStringNoCity name
stateStringNoState name
postalCodeStringNoPostal code
countryStringNoCountry name

 

rating

String

No

The account’s prospect rating. For example, Hot, Warm, or Cold.

phoneOffice

String

No

Office phone number.

phoneAlternate

String

No

Alternative phone number.

website

String

No

The website of this account.

ownershipType

String

No

Ownership type for the account. For example Private, Public, or Subsidiary.

numOfEmployees

Integer

No

Number of employees. 

tickerSymbol

String

No

The stock ticker symbol for the account.

shippingAddress

String

No

Shipping address

KeyTypeMandatory?Description
streetStringNoStreet name
cityStringNoCity name
stateStringNoState name
postalCodeStringNoPostal code
countryStringNoCountry name

 

campaignId

String

No

The campaign ID assigned to the account.

accountNumber

String

No

Unique account number assigned to the account.

originalAccountNumber

String

No

Unique account number assigned to the account from originating source, such as Salesforce.

agentId

Integer

No

The agent ID assigned to the account.

agentTeamId

Integer

No

The agent team ID assigned to the account.

accountSource

String

No

The source of the account record. For example, Advertisement, Data.com, or Trade Show. 

sicCodeStringNoStandard Industrial Classification (SIC) code of the account's main business categorization.
sicDescStringNoA brief description of an organization’s line of business, based on its SIC code.

classificationId

Integer

No

The account classification ID.

customFields

Array

No

Custom field values associated to an account.

KeyTypeMandatory?Description
fieldEnumYes

Custom field name where the data will be stored. Valid values are:

  • COL1
  • COL2

...

  • COL100
valueStringYes

The value to place into the custom field.

The max length per custom field is 255 characters.

 

typeId

Integer

No

The account type ID. 

classificationName

String

No

The account classification name. 

typeName

String

No

The account type name. 

agentName

String

No

Name of the agent assigned to the account.

agentTeamName

String

No

Name of the agent team assigned to the account.

history

Object

No

The account history

KeyTypeMandatory?Description
clientIdIntegerNoClient ID of the history record.
createdByStringNoThe username who created the history record.
createdDateDateNoCreation date of the history record.
descriptionsString NoDescription of the changes.
idIntegerNoPrimary key for the history record.
nameStringNoName of the history record.
parentTypeENUMNoType of record being updated. It can be one of the following values: ACCOUNT, NOTE, VIEW, TICKET, OPPORTUNITY, LEAD, AGENT, USER, CONTACT, COMMENT.
parentIdIntegerNoID associated with the parentType record.

 

primaryAccountContact

String

No

Primary account value.

logId

UUID

No

Error ID.

errorMsg

String

No

Error description.

primaryContact

Object

No

Primary contact information

KeyTypeMandatory?Description
idIntegerNoPrimary Key for the contact record.
createdDateDateNoCreation date of the contact record.
createdByStringNoName of the user who created the contact record.
modifiedDateDateNoModification date of the contact record.
modifiedByStringNoName of the user who modified the contact record.
contactStringNoName of the contact record.
accountIdIntegerNoID for the account record that is associated with the contact.
originalAccountIdStringNoUnique account number assigned to the account from the originating source. For example, Salesforce. Used to fetch the accountId only.

 

List Accounts by Providing Offset Values

#Request (JSON)
Get /account/accounts?offset=5&count=2
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response
200 Ok
Content-Type: application/json  {
  "next": "/account/accounts?offset=7",
  "listAccount": [
    {
      "id": 607281,
      "createdDate": 1673980064556,
      "createdBy": "apiSysAdmin",
      "modifiedDate": 1673980064556,
      "clientId": 94572,
      "name": "12q211673841660000",
      "description": "2q1673841660000",
      "industry": "2q1673841660000",
      "annualRevenue": 100,
      "phoneFax": "6503510000",
      "rating": "Hot",
      "phoneOffice": "6503517000",
      "phoneAlternate": "6503517400",
      "website": "www.livevox.com",
      "tickerSymbol": "LV",
      "sicCode": "qa12345678",
      "number": 142,
      "accountNumber": "qa1211qa123",
      "originalAccountNumber": "OAN12",
      "site": "Bang",
      "accountSource": "Advertisement",
      "sicDesc": "qa1234567",
      "customFields": [
        {
          "field": "COL1",
          "value": "123"
        }
      ],
      "billingAddress": {
        "street": "Bangalore_1",
        "city": "Bangalore",
        "state": "KA",
        "postalCode": "560001",
        "country": "INDIA"
      },
      "ownershipType": "Private",
      "numOfEmployees": 1000,
      "shippingAddress": {
        "street": "Bangalore_2",
        "city": "Bangalore2",
        "state": "KA2",
        "postalCode": "560001",
        "country": "IND"
      }
    },
    {
      "id": 607646,
      "createdDate": 1688620601288,
      "createdBy": "apiSysAdmin",
      "modifiedDate": 1688620844579,
      "modifiedBy": "apiSysAdmin",
      "clientId": 94572,
      "name": "131aq1688616060000",
      "description": "3q1688616060000",
      "industry": "3q1688616060000",
      "annualRevenue": 200,
      "phoneFax": "6503510001",
      "rating": "warm",
      "phoneOffice": "6503517001",
      "phoneAlternate": "6503517401",
      "website": "www.live.com",
      "tickerSymbol": "LV1",
      "sicCode": "qa12345678",
      "number": 244,
      "accountNumber": "qa2q1qa123",
      "originalAccountNumber": "OAN123",
      "agentId": 635534,
      "agentTeamId": 16364,
      "accountSource": "Advertisement",
      "sicDesc": "qa1234567",
      "agentTeamName": "apitestteam",
      "billingAddress": {
        "street": "Bangalore_2",
        "city": "Bangalore_2",
        "state": "KAS",
        "postalCode": "560002",
        "country": "INDIA"
      },
      "shippingAddress": {
        "street": "Bangalore_1",
        "city": "KAS",
        "postalCode": "560002",
        "country": "INDIA"
      }
    }
  ]
}   
CODE

Find Matching Accounts

Description: Searches for accounts that match the specified criteria. 

User Roles: Sysadmin, Superuser, or Manager

Method: POST /account/accounts/search?count={n}&offset={n}

Parameters:

Path/Query Parameter Name

Variable Name

Type

Mandatory?

Description

countnIntegerYesSpecifies the number of items to return in the list. There is a hard cap of 1000 items.
offsetnIntegerYesRequired for pagination. Specifies the offset from 0, based on the count, to start listing from.

Body:

KeyTypeMandatory?Description

search

Object

No

An object specifying the search criteria

KeyTypeMandatory?Description

id

Integer

No

Account ID.

createdDateStartDate

No

The start date of the date range to return account records which have a ‘createdDate’ as same or after this date. It could take Unix timestamp format like 1577858400000 (in milliseconds).
createdDateEndDate

No

The end date of the date range to return account records which have a 'createdDate' as same or before this date.It could take Unix timestamp format like 1577858400000 (in milliseconds).

createdByString

No

The username who created the account.
modifiedDateStartDate

No

The start date of the date range to return account records which have a ‘modifiedDate’ as same or after this date. It could take Unix timestamp format like 1577858400000 (in milliseconds).
modifiedDateEndDate

No

The end date of the date range to return account records which have a 'modifiedDate' as same or before this date. It could take Unix timestamp format like 1577858400000 (in milliseconds).

modifiedByString

No

The username who last modified the account.

name

String

No

Account name. 

description

String

No

Description of the account.

industry

String

No

Industry to which the account belongs.

annualRevenueStart

Integer

No

The amount that the annual revenue of the account is greater than or equal to.

annualRevenueEnd

Integer

No

The amount that the annual revenue of the account is less than or equal to.

phoneFax

String

No

Phone or fax number.

billingAddress

String

No

Billing address

KeyTypeMandatory?Description
streetStringNoStreet name
cityStringNoCity name
stateStringNoState name
postalCodeStringNoPostal code
countryStringNoCountry name

 

rating

String

No

The account’s prospect rating. For example, Hot, Warm, or Cold.

phoneOffice

String

No

Office phone number.

phoneAlternate

String

No

Alternate phone number.

website

String

No

The website of this account.

ownershipType

String

No

Ownership type for the account. For example, Private, Public, or Subsidiary.

numOfEmployees

Integer

No

Number of employees. 

tickerSymbol

String

No

The stock ticker symbol for the account.

shippingAddress

String

No

Shipping address

KeyTypeMandatory?Description
streetStringNoStreet name
cityStringNoCity name
stateStringNoState name
postalCodeStringNoPostal code
countryStringNoCountry name

 

campaignId

String

No

The campaign ID assigned to the account.

accountNumber

String

No

Unique account number assigned to the account within a client.

originalAccountNumber

String

No

Unique account number assigned to the account from originating source, like Salesforce.  

agentId

Integer

No

The agent ID assigned to the account.

agentTeamId

Integer

No

The agent team ID assigned to the account.

accountSource

String

No

The source of the account record. For example, Advertisement, Data.com, or Trade Show. 

sicCodeStringNoStandard Industrial Classification (SIC) code of the account's main business categorization.
sicDescStringNoA brief description of an organization’s line of business, based on its SIC code.

classificationId

Integer

No

The account classification ID.

customFieldSearchs

Array

No

Custom fields are defined by you in the Portal, and even though their values are stored in strings, their meanings are defined by the associated data type which is also defined in Portal.

To search custom fields, you need to provide the types defined for the fields and fill in the additional related attributes.

KeyTypeMandatory?Description
fieldEnumYes

Custom field name where the data will be stored. Valid values are:

  • COL1
  • COL2

...

  • COL100
criteriaObjectYes

KeyTypeMandatory?Description
typeEnumYes

Valid values are:

  • STRING
  • DATE
  • NUMBER
  • BOOLEAN
  • LIST
startStringNoUsed when type is DATE or NUMBER.
endStringNoUsed when type is DATE or NUMBER.
valueStringNoUsed when type is STRING or BOOLEAN.
listValuesArrayNoUsed when type is LIST.

 

typeId

Integer

No

The account type ID.

contactId

String

No

ContactId associated with the account. It is a unique ID to identify a contact in Contact Manager, where it is also called "account".

agentIdsArrayNoA list of agent IDs.
agentTeamIdsArrayNoA list of agent team IDs.
classificationIdsArrayNoA list of account classification IDs.
typeIdsArrayNoA list of account type IDs.
sortObject

No

An object indicating the attribute to sort by

KeyTypeMandatory?Description
directionENUMYesASC (ascending), DESC (descending).
propertyStringYesThe attribute by which to sort.

Response Code: 

Body: 

KeyTypeMandatory?Description
nextURINoA URI for the next page of entries. If next is not present, or blank, then there are no pages after this one.
findMatchingAccountsArrayNo

A list of accounts

KeyTypeMandatory?Description

id

Integer

Yes

Account ID.

createdDateDateYesThe creation date of the account (Unix timestamp format).
createdByStringYesThe username who created the account.
modifiedDateDateYesThe most recent modification date of the account  (Unix timestamp format).
modifiedByStringYesThe username who last modified the account.

name

String

Yes

Account name.

description

String

No

Description of the account.

industry

String

No

Industry to which the account belongs. 

annualRevenue

Integer

No

Annual revenue of the account.

phoneFax

String

No

Phone or fax number.

billingAddress

String

No

Billing address

KeyTypeMandatory?Description
streetStringNoStreet name
cityStringNoCity name
stateStringNoState name 
postalCodeStringNoPostal code
countryStringNoCountry name

 

rating

String

No

The account’s prospect rating. For example, Hot, Warm, or Cold.

phoneOffice

String

No

Office phone number.

phoneAlternate

String

No

Alternate phone number.

website

String

No

The website of this account.

ownershipType

String

No

Ownership type for the account, for example Private, Public, or Subsidiary.

numOfEmployees

Integer

No

Number of employees.

tickerSymbol

String

No

The stock ticker symbol for the account.

shippingAddress

String

No

Shipping address

KeyTypeMandatory?Description
streetStringNoStreet name
cityStringNoCity name
stateStringNoState name
postalCodeStringNoPostal code
countryStringNoCountry name

 

campaignId

String

No

The campaign ID assigned to the account.

accountNumber

String

No

Unique account number assigned to the account within a client.

originalAccountNumber

String

No

Unique account number assigned to the account from originating source, like Salesforce.

agentId

Integer

No

The agent ID assigned to the account.

agentTeamId

Integer

No

The agent team ID assigned to the account.

accountSource

String

No

The source of the account record. For example, Advertisement, Data.com, or Trade Show. 

sicCodeStringNoStandard Industrial Classification (SIC) code of the account's main business categorization.
sicDescStringNoA brief description of an organization’s line of business, based on its SIC code.

classificationId

Integer

No

The account classification ID.

customFields

Array

No

Custom field values associated to an account.

KeyTypeMandatory?Description
fieldEnumYes

Custom field name where the data will be stored. Valid values are:

  • COL1
  • COL2

...

  • COL100
valueStringYes

The value to place into the custom field.

The max length per custom field is 255 characters.

 

typeId

Integer

No

The account type ID.

classificationName

String

No

The account classification name.

typeName

String

No

The account type name. 

agentName

String

No

Name of the agent assigned to the account.

agentTeamName

String

No

Name of the agent team assigned to the account.

Find the Matching Account

#Request (JSON)
POST /account/accounts/search?offset=0&count=3
Host: localhost.com
Content-Type: application/json

{
  "search": {
    "name": "200"
  }
}

#Response
200 OK
Content-Type: application/json

{
  "next": "account/accounts/search?offset=3&count=3",
  "listAccount": [
    {
      "name": "QA042220055716",
      "description": "QA042220055716",
      "billingAddress": {},
      "shippingAddress": {},
      "accountNumber": "343",
      "agentId": 12345,
      "customFields": [],
      "id": 54065,
      "createdDate": 1587553036759,
      "createdBy": "apiSysAdmin",
      "modifiedDate": 1587553036759
    },
    {
      "name": "QA042220070650",
      "description": "QA042220070650",
      "billingAddress": {},
      "shippingAddress": {},
      "accountNumber": "468",
      "agentTeamId": 12345,
      "customFields": [],
      "id": 54190,
      "createdDate": 1587557211140,
      "createdBy": "apiSysAdmin",
      "modifiedDate": 1587557211140
    },
    {
      "name": "QA042220071429",
      "description": "QA042220071429",
      "billingAddress": {},
      "shippingAddress": {},
      "accountNumber": "510",
      "agentTeamId": 12345,
      "customFields": [],
      "id": 54232,
      "createdDate": 1587557670106,
      "createdBy": "apiSysAdmin",
      "modifiedDate": 1587557670106
    }
  ]
}
CODE

Update Account

Description:  Modifies the information for an account. When updating the account information, the system validates against Agent ID, Agent Team ID, Campaign ID, account Classification ID, and account Type ID. You can provide the required attributes that need to be updated in the request. Attributes not included in the request will remain unchanged. If an attribute needs to be set to null, include the property in the request with the "null" value.

User Roles: Sysadmin or Superuser

Method: PUT /account/accounts/{id}

Parameters:

Path/Query Parameter Name

Type

Mandatory?

Description

idIntegerYesAccount ID  to be updated.

Body:

Key

Type

Mandatory?

Description

name

String

No

Account name and it can be duplicated.

description

String

No

Description of the account.

industry

String

No

Industry the account belongs to.

annualRevenue

Integer

No

Annual revenue of the account.

phoneFax

String

No

Phone or fax number.

billingAddress

String

No

Billing address

KeyTypeMandatory?Description
streetStringNoStreet name
cityStringNoCity name
stateStringNoState name
postalCodeStringNoPostal code
countryStringNoCountry name

 

rating

String

No

The account’s prospect rating. For example, Hot, Warm, or Cold.

phoneOffice

String

No

Office phone number.

phoneAlternate

String

No

Alternate phone number.

website

String

No

The website of this account.

ownershipType

String

No

Ownership type for the account. For example, Private, Public, or Subsidiary. 

numOfEmployees

Integer

No

Number of employees.

tickerSymbol

String

No

The stock ticker symbol for the account.

shippingAddress

String

No

Shipping address

KeyTypeMandatory?Description
streetStringNoStreet name
cityStringNoCity name
stateStringNoState name
postalCodeStringNoPostal code
countryStringNoCountry name

 

campaignId

String

No

The campaign ID assigned to the account.

accountNumber

String

No

Unique account number assigned to the account within a client.

originalAccountNumber

String

No

Unique account number assigned to the account from originating source, like Salesforce.

agentId

Integer

No

The agent ID assigned to the account.

agentTeamId

Integer

No

The agent team ID assigned to the account.

accountSource

String

No

The source of the account record. For example, Advertisement, Data.com, or Trade Show. 

sicCodeStringNoStandard Industrial Classification (SIC) code of the account's main business categorization.
sicDescStringNoA brief description of an organization’s line of business, based on its SIC code.

classificationId

Integer

No

The account classification ID.

customFields

Array

No

Custom field values associated to an account.

KeyTypeMandatory?Description
fieldEnumYes

Custom field name where the data will be stored. Valid values are:

  • COL1
  • COL2
  • COL3
  • COL4

...

  • COL99
  • COL100
valueStringYes

The value to place into the custom field.

The max length per custom field is 255 characters.

 

secureFields

Array

No

Secure field values associated to an account.

KeyTypeMandatory?Description
fieldEnumYes

Secure field name where the data will be stored. Valid values are:

  • SECURE1
  • SECURE2

...

  • SECURE5
valueStringYes

The value to place into the secure field.

 

typeId

Integer

No

The account type ID.

Response Code: 204 No Content

Body:

None

Update an Account

#Request (JSON)
PUT /account/accounts/604423
Host: localhost.com
Content-Type: application/json

{
  "name": "DOC123",
  "description": "Test for Doc",
  "industry": "Telecom Software",
  "annualRevenue": "5000",
  "phoneFax": "8456911158",
  "billingAddress": {
    "street": "MG Road",
    "city": "Bangalore",
    "state": "Karnataka",
    "postalCode": "560005",
    "country": "India"
  },
  "rating": "Excellent"
}

#Response
204 No Content
Content-Type: application/json
CODE

Update the Account that Doesn't Exist

#Request (JSON)
PUT /account/accounts/604451
Host: localhost.com
Content-Type: application/json

{
  "name": "DOC123x",
  "description": "Test for Doc",
  "industry": "Telecom Software",
  "annualRevenue": "5000",
  "phoneFax": "8456911158",
  "billingAddress": {
    "street": "MG Road",
    "city": "Bangalore",
    "state": "Karnataka",
    "postalCode": "560005",
    "country": "India"
  },
  "rating": "Excellent"
}

#Response
404 No Found
Content-Type: application/json

{
  "code": 203,
  "message": "No Record Found"
}
CODE

Add Note to Account

Description:  Adds a note to the specified account.

User Roles: Sysadmin or Superuser

Method: POST /account/accounts/{id}/notes 

Parameters:

None

Body:

Key

Type

Mandatory?

Description

name

String

Yes

Name of the note.

descriptionStringNoDescription of the note.

Response Code: 204 No Content

Body:

None

Add a note to an account

#Request (JSON)
POST /account/accounts/604434/notes
Host: localhost.com
Content-Type: application/json

{
  "name": "Note1",
  "description": "Documentation Note"
}

#Response
204 No Content
Content-Type: application/json
CODE

Delete Account

Description:  Deletes an account from the Account editor of LiveVox Portal.

User Roles: Sysadmin or Superuser

Method: Delete /account/accounts/{id}

Parameters:

Path/Query Parameter Name

Type

Mandatory?

Description

idIntegerYesAccount ID  to be deleted.

Body:

None

Response Code: 204 No Content

Body:

None

Delete an Account

#Request (JSON)
DELETE /account/accounts/604434
Host: localhost.com
Content-Type: application/json

#Response
204 No Content
Content-Type: application/json
CODE

Link / Unlink Account to Contacts

The Account methods allow you to associate and dissociate Livevox accounts to contacts.

Link Account to Contact

Description: Associate an account with a contact. The system validates against the Account ID and Contact ID.

User Roles: Sysadmin, Superuser, or Manager

Method: POST /account/accounts/{id}/contacts

Parameters:

Path/Query Parameter Name

Type

Mandatory?

Description

id

Integer

Yes

Account ID to be linked.

Body:

Key

Type

Mandatory?

Description

contactId

String

Yes

Contact ID is unique ID to identify a contact in Contact Manager, where it is also called "account".

Response Code: 204 No Content. 

Body:

None 

Link an Account to the Contact

#Request (JSON)
POST /account/accounts/604423/contacts
Host: localhost.com
Content-Type: application/json

{
  "contactId": "qa123"
}
 
#Response
204 No Content
Content-Type: application/json
CODE

Link an Account to the Contact that Already Linked

#Request (JSON)
POST /account/accounts/604423/contacts
Host: localhost.com
Content-Type: application/json

{
  "contactId": "qa123"
}
 
#Response
409 Conflict
Content-Type: application/json

{
  "code": 409,
  "message": "Association already exists."
}
CODE

Link Account to Multiple Contacts

Description: Associate an account with multiple contacts. For bulk operation, the system does not validate against the Account ID and Contact ID.

User Roles: Sysadmin, Superuser, or Manager

Method: POST /account/accounts/{id}/contacts/bulk

Parameters:

Path/Query Parameter Name

Type

Mandatory?

Description

id

Integer

Yes

Account ID to be linked.

Body:

Key

Type

Mandatory?

Description


Array

Yes

An array of Contact IDs. Contact ID is unique to identify a contact in Contact Manager, where it is also called "account".

Key

Type

Mandatory?

Description

contactId

String

No

Contact ID

Response Code: 200 OK

Body:

KeyTypeMandatory?Description
successCountIntegerYesThe number of contacts successfully linked to the account
failCountIntegerYesThe number of contacts failed to be linked to the account.
failedDataArrayNo

A list of hints to failed data

KeyTypeMandatory?Description

itemName

String

Yes

ContactId

causeStringYesThe cause of failure

Link the Account with Multiple Contacts

#Request (JSON)
POST /account/accounts/604423/contacts/bulk
Host: localhost.com
Content-Type: application/json
  
[
  {
    "contactId": "0001"
  },
  {
    "contactId": "000"
  },
  {
    "contactId": "DOC123a"
  },
  {
    "contactId": "Doc1234a"
  }
]
   
#Response
200 OK
Content-Type: application/json
 
{
  "successCount": 2,
  "failCount": 2,
  "failedData": [
    {
      "itemName": "0001",
      "cause": "This contact has been associated with the account."
    },
    {
      "itemName": "000",
      "cause": "This contact has been associated with the account."
    }
  ]
}
CODE

Unlink an Account With a Contact

Description:  Dissociates an account with a contact.

User Roles: Sysadmin, Superuser, or Manager

Method: DELETE  /account/accounts/{id}/contacts/{contactId}

Parameters:

Path/Query Parameter Name

Type

Mandatory?

Description

id

Integer

Yes

Account ID to be unlinked.

contactId

String

Yes

Contact ID is unique to identify a contact in Contact Manager, where it is also called "account".

Body:

None

Response Code: 204 No Content

Body: 

None

Unlink the Account From the Contact

#Request (JSON)
DELETE /account/accounts/604423/contacts/API199
Host: localhost.com
Content-Type: application/json
  
#Response
204 No Content
Content-Type: application/json
CODE

Account Classifications 

The classification methods allow you to create, read, modify, delete, and list all classifications for an account.

Create Classification

Description: Create a classification for accounts. 

User Roles: Sysadmin or Superuser

Method: POST /account/classifications

Parameters:

None

Body:

Key

Type

Mandatory?

Description

name

String

Yes

Classification name.

Response Code: 201 Created

Body:

Key

Type

Mandatory?

Description

idIntegerYesThe ID of the newly created classification.

Create a Classification

#Request (JSON)
POST /account/classification
Host: localhost.com
Content-Type: application/json
 
{
  "name": "Bronze"
}
  
#Response
201 Created
Content-Type: application/json

{
  "id": 181
}
CODE

Read Classification

Description: Gets the classification details.

User Roles: Sysadmin, Superuser, or Manager

Method: GET /account/classifications/{id}

Parameters:

Path/Query Parameter Name

Type

Mandatory?

Description

idIntegerYesClassification ID to be read.

Body:

None

Response Code: 200 OK

Body:

KeyTypeMandatory?Description

id

Integer

Yes

The ID of the classification.

name

String

Yes

Name of the classification.

level

Integer

No

A number indicating the sequence in the display.

Get the classification details

#Request (JSON)
GET /account/classification/171
Host: localhost.com
Content-Type: application/json
 
#Response
200 OK
Content-Type: application/json

{
  "level": 1,
  "name": "Platinum",
  "id": 171
}
CODE

List All Classification

Description: List all available classifications. 

User Roles: Sysadmin, Superuser, or Manager

Method: GET /account/classifications

Parameters:

None

Body: 

None

Response Code: 200 OK

Body:

KeyTypeMandatory?Description

ArrayNo

A list of classifications

KeyTypeMandatory?Description
levelIntegerNoA number indicating the sequence in the display.

name

String

Yes

Name of the classification.
idIntegerNoThe ID of the classification.

List all Available Classifications

#Request (JSON)
GET /account/classifications
Host: localhost.com
Content-Type: application/json
 
#Response
200 OK
Content-Type: application/json

[
  {
    "level": 1,
    "name": "Platinum",
    "id": 171
  },
  {
    "level": 2,
    "name": "Gold",
    "id": 172
  },
  {
    "level": 3,
    "name": "Silver",
    "id": 173
  },
  {
    "level": 4,
    "name": "Bronze",
    "id": 181
  }
]
CODE

Update Classification

Description: Modifies an existing classification. 

User Roles: Sysadmin or Superuser

Method: PUT /account/classification/{id}

Parameters:

Path/Query Parameter Name

Type

Mandatory?

Description

idIntegerYesClassification ID to be updated.

Body:

Key

Type

Mandatory?

Description

name

String

No

Name of the classification

level

Integer

No

A number indicating the sequence in the display.

Response Code: 204 No Content

Body: 

None

Update the Classification

#Request (JSON)
PUT /account/classification/181
Host: localhost.com
Content-Type: application/json
  
{
  "name": "Brass",
  "level": "6"
}
   
#Response
204 No Content
Content-Type: application/json
CODE

Delete Classification

Description: Deletes an existing classification.

User Roles: Sysadmin or Superuser

Method: DELETE /account/classification/{id}

Parameters:

Path/Query Parameter Name

Type

Mandatory?

Description

idIntegerYesClassification ID to be deleted.

Body:

None

Response Code: 204 No Content

Body:

None

Delete the Classification

#Request (JSON)
DELETE /account/classification/182
Host: localhost.com
Content-Type: application/json
    
#Response
204 No Content
Content-Type: application/json
CODE

Account Types 

The account types methods allow you to create, read, modify, delete, and list all account types.

Create Type

Description: Create an account type 

User Roles: Sysadmin or Superuser

Method: POST /account/types

Parameters:

None

Body: 

Key

Type

Mandatory?

Description

name

String

Yes

Name of the account type.

Response Code: 201 Created

Body:

Key

Type

Mandatory?

Description

idIntegerYesThe ID of the newly created type.

Create an Account Type

#Request (JSON)
POST /account/types
Host: localhost.com
Content-Type: application/json
  
{
  "name": "Advertisement"
}
   
#Response
201 Created
Content-Type: application/json
 
{
  "id": 192
}
CODE

Read Type

Description: Read the account type

User Roles: Sysadmin or Superuser

Method: GET /account/type/{id}

Parameters:

Path/Query Parameter Name

Type

Mandatory?

Description

idIntegerYesAccount type ID to be read.

Body:

None

Response Code: 200 OK

Body:

KeyTypeMandatory?Description
LevelInteger NoA number indicating the sequence in display.

name

String

Yes

Name of the account type.

idIntegerYesID of the account type.

Get the Account Type Details

#Request (JSON)
GET /account/type/184
Host: localhost.com
Content-Type: application/json
  
   
#Response
200 OK
Content-Type: application/json
 
{
  "level": 3,
  "name": "Grocery",
  "id": 184
}
CODE

List All Types

Description: Gets all available account types. 

User Roles: Sysadmin, Superuser, or Manager

Method: GET /account/types

Parameters:

None

Body:

None

Response Code: 200 OK

Body:

KeyTypeMandatory?Description

ArrayNo

A list of types

KeyTypeMandatory?Description
levelIntegerNoA number indicating the sequence in display.

name

String

Yes

Name of the account type.

idIntegerNoID of the type.

List all Available Account Types

#Request (JSON)
GET /account/types
Host: localhost.com
Content-Type: application/json
  
#Response
200 OK
Content-Type: application/json

[
  {
    "level": 1,
    "name": "Hospital",
    "id": 48
  },
  {
    "level": 2,
    "name": "Bank",
    "id": 183
  },
  {
    "level": 3,
    "name": "Grocery",
    "id": 184
  },
  {
    "level": 4,
    "name": "Advertisement",
    "id": 192
  }
]
CODE

Update Type

Description: Modifies the account type. 

User Roles: Sysadmin or Superuser

Method: PUT /account/type/{id}

Parameters:

Path/Query Parameter Name

Type

Mandatory?

Description

idIntegerYesAccount type ID to be update.

Body:

Key

Type

Mandatory?

Description

name

String

No

Name of the account type.

level

Integer

No

A number indicating the sequence in display.

Response Code: 204 No Content

Body:

None

Update the Account Type

#Request (JSON)
PUT /account/type/192
Host: localhost.com
Content-Type: application/json
   
{
  "name": "Marketing",
  "level": "6"
}
    
#Response
204 No Content
Content-Type: application/json
CODE

Delete Type

Description: Deletes the account type. 

User Roles: Sysadmin or Superuser

Method: DELETE /account/type/{id}

Parameters:

Path/Query Parameter Name

Type

Mandatory?

Description

idIntegerYesAccount type ID to be deleted.

Body:

None

Response Code: 204 No Content

Body:

None

Delete the Account Type

#Request (JSON)
DELETE /account/type/193
Host: localhost.com
Content-Type: application/json
     
#Response
204 No Content
Content-Type: application/json
CODE

Errors

For more information, see the Errors section on the REST APIs page. 

Top of Page