v53

latestOpenAPI 3.1.1raw.githubusercontent.com2026-07-264065213.4 KB

Accounts

Archive an account

Archives an account and releases all associated resources.

Warning: This action will:

Release all phone numbers associated with the account
Deactivate all campaigns
Make the account unusable for sending messages

This operation is irreversible. If you need to send SMS in the future, you will need to re-register new phone numbers and campaigns.

delete/accounts/{id}

Path parameters

idstring required

The ID of the account to archive.

Example:acct_01jpqjvfg9enpt7pyxd60pcmxj

Response

Archived account

brand_namestring nullable required

The name by which the people this account communicates with know it. If not provided, this will match the name field.

idstring required

The account ID

namestring required

The name of the account that will be visible for your internal organizational purposes. This will also be the default public-facing brand name unless you also set a brand_name, but otherwise the account name will never be displayed anywhere outside of Surge HQ, and may include your ID for the account or anything else that may help you.

time_zonestring nullable required

This is the time zone in which the account is headquartered. This time zone may be used for compliance with TCPA restrictions on when messages may be sent.

Example response

{
  "brand_name": "DT Precision Auto",
  "id": "acct_01jpqjvfg9enpt7pyxd60pcmxj",
  "name": "Account #2840 - DT Precision Auto",
  "organization": {
    "address": {
      "country": "US",
      "line1": "2640 Huron St",
      "line2": null,
      "locality": "Los Angeles",
      "name": "DT Precision Auto",
      "postal_code": "90065",
      "region": "CA"
    },
    "contact": {
      "email": "dom@dtprecisionauto.com",
      "first_name": "Dominic",
      "last_name": "Toretto",
      "phone_number": "+13235556439",
      "title": "other",
      "title_other": "Owner"
    },
    "country": "US",
    "email": "dom@dtprecisionauto.com",
    "identifier": "123456789",
    "identifier_type": "ein",
    "industry": "automotive",
    "mobile_number": "+13235556439",
    "regions_of_operation": [
      "usa_and_canada"
    ],
    "registered_name": "DT Precision Auto LLC",
    "stock_exchange": null,
    "stock_symbol": null,
    "type": "llc",
    "website": "https://dtprecisionauto.com"
  },
  "time_zone": "America/Los_Angeles"
}