Marketing EdgeMPSSonarCallcap

Accounts

Suggest Edits

Create

HTTP method: POST
URL: https://api.callcap.com/v3/accounts/:accountParent/children

Path parameter

  • accountParent = "D-100"
    • To create a new account you must specify the new account's parent account. Valid accountParents are of type "Corporate" (C) and "Division" (D).
    • Your login must have accounts access to the parent account to create child accounts.
    • A Corporate account will create Division accounts as children.
    • A Division account will create Location accounts as children.
    • Location accounts do not have account children. They hold phone numbers which are created using the /v3/numbers resource.
    • Example: POST https://api.callcap.com/v3/accounts/D-100/children

POST parameters

  • accountName = "My account name"
    • The name for the created account. Name is required.
  • companyID = "MY-COMPANY-01"
    • A way to associate an internal company ID with a Callcap account.
  • externalID = "Location or Division External ID"
    • A way to associate an external Division or Location ID with a Callcap account.

For Location accounts only

  • companyBrand = "Brand label"
    • A way to associate multiple company brands with your Callcap Location accounts.
  • systemTimezone = "US/Central"
    • The timezone used for phone system routing (such as for time of day routing).
    • A limited subset of timezones is valid:
      • US/Hawaii
      • US/Alaska
      • US/Pacific
      • US/Mountain
      • Canada/Atlantic
      • US/Central
      • US/Eastern
  • copyMinorsFromAccount = "L-99"
    • To copy Callsurance evaluation minors from another account. Your login must have Evaluation access to both the new account's parent account and the account to copy from. Only Location (L) accounts are valid.

Update

HTTP method: POST
URL: https://api.callcap.com/v3/accounts/:account

PATH parameter

  • account = "L-3"
    • The account key of the account to modify. All account levels are valid (C, D, L).
    • Your login must have accounts access to the account to modify it.
    • Example: POST https://api.callcap.com/v3/accounts/L-3

POST parameters

  • accountName = "My account name"
    • Update the name of the account. Can not be set to empty string.
  • companyID = "MY-COMPANY-01"
    • A way to associate an internal company ID with a Callcap account.
  • externalID = "Location or Division` External ID"
    • A way to associate an external Location or Division ID with a Callcap account.

For Location accounts only

  • companyBrand = "Brand label"
    • A way to associate multiple company brands with your Callcap Location accounts.
  • systemTimezone = "US/Central"
    • The timezone used for phone system routing (such as for time of day routing).
    • A limited subset of timezones is valid:
      • US/Hawaii
      • US/Alaska
      • US/Pacific
      • US/Mountain
      • Canada/Atlantic
      • US/Central
      • US/Eastern

Disable

HTTP method: DELETE
URL: https://api.callcap.com/v3/accounts/:account

GET parameters (with example)

This resource will mark the account as disabled. This will prevent the account from being displayed and no new phone numbers can be created within it.

Note: This does not shut off active phone numbers within the disabled account. If this is needed, please use the /v3/numbers/ resource to shut off phone numbers before disabling an account.

PATH parameter

  • account = "L-3"
    • The account key of the account to modify. All account levels are valid (C, D, L).
    • Your login must have accounts access to the account to disable it.
    • Example: DELETE https://api.callcap.com/v3/accounts/L-3

Updated 9 months ago