Skip to main content
POST
Suspend account
Required scope: PARTNER
Suspends an account you provisioned, right away, for example when your customer stops paying you. The account keeps its numbers, its eSIMs and its history, so Resume account restores everything as it was. The response returns the account with status: SUSPENDED.

What stops

The suspension covers every member and every number of the account. Each member’s status becomes SUSPENDED, and a member you add while the account is suspended is SUSPENDED from the start.
  • Inbound calls are refused: they do not ring the apps or the eSIMs.
  • Outbound calls from the Allo apps play a short message instead, saying the line is suspended and asking the caller to contact their provider. The message does not name Allo.
  • Outgoing SMS are refused with 403 ACCOUNT_SUSPENDED. On /v2/sms, the endpoint the Allo apps use, the error code is Allo.9.
  • The AI receptionist does not answer, since inbound calls stop before they reach it.
  • eSIM lines are suspended at the mobile network, since their holder is SUSPENDED. This usually takes seconds. If the network does not confirm at once, Allo retries every 5 minutes. Until then, calls and SMS on the eSIM itself can still go through.

What stays

  • The account’s numbers, its eSIMs and its call and message history.
  • Incoming SMS are stored in the conversation, with no notification and no automatic reply.
  • Sign-in. Members can still open the Allo apps and read their history. They cannot call or text.
  • Billing does not change. The subscription you pay for the account keeps running and renews as usual. To stop billing, deactivate the account.

Webhook and idempotency

Allo sends partner.account.suspended to your own webhook endpoint, not to the account’s. Without a webhook endpoint, read the status with Get account. The request is idempotent. Suspending an account that is already suspended changes nothing, and Allo sends no second webhook. {id} is the account id returned by Create account. An account your API key did not create, or one already deactivated, returns 404 PARTNER_ACCOUNT_NOT_FOUND.

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

The account id returned by Create account (usr-*).

Response

The account, with its new status

data
object