SUsurgeapi
Accounts

Check account status

Changed on

Check an account's status and capabilities

get/accounts/{account_id}/status

Request

  • Base URL
    https://api.surge.app
  • URL
    https://api.surge.app/accounts/{account_id}/status
  • Auth
    HTTP bearer

Path parameters

account_idstring required

ID of the account to check

Example:acct_01jpqjvfg9enpt7pyxd60pcmxj

Query parameters

capabilitiesstring[]

capabilities about which to check the status

Response

Account status

capabilitiesobject required

An object where the fields are the capabilities passed in the capabilities query param, as in local_messaging.

Example response

{
  "capabilities": {
    "local_messaging": {
      "errors": [
        {
          "field": "organization.registered_name",
          "message": "The provided EIN doesn't match the organization's registered name.",
          "type": "ein_mismatch"
        }
      ],
      "fields_needed": [],
      "status": "error"
    },
    "phone_calls": {
      "errors": [],
      "fields_needed": [],
      "status": "ready"
    },
    "toll_free_messaging": {
      "errors": [],
      "fields_needed": [
        "organization.contact.title_other",
        "organization.mobile_number"
      ],
      "status": "incomplete"
    }
  }
}

Changes

  • 9c83a903ab72Revision changes
    • info

      added the enum value toll_free_messaging to the property items/ of the query request parameter capabilities