> ## Documentation Index
> Fetch the complete documentation index at: https://help.withallo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Suspend account

> Suspends an account you provisioned, right away. Inbound and outbound calls, outgoing SMS and the AI receptionist stop for every member of the account: each member's status becomes `SUSPENDED`, and their eSIM lines are suspended. The account keeps its numbers, its eSIMs and its history, and its billing does not change. Incoming SMS are stored without any notification. Idempotent: suspending an account that is already suspended changes nothing and sends no second webhook. Allo sends `partner.account.suspended` to your webhook endpoint. Requires the `PARTNER` scope.

> [!NOTE]
>
> **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](https://help.withallo.com/en/v2/api-reference/white-label/resume-account.md) 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](https://help.withallo.com/en/v2/api-reference/white-label/add-member.md) 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](https://help.withallo.com/en/v2/api-reference/partner/delete-account.md).

## Webhook and idempotency

Allo sends [`partner.account.suspended`](https://help.withallo.com/en/v2/api-reference/webhooks/event-catalog#partneraccountsuspended) to your own webhook endpoint, not to the account's. Without a webhook endpoint, read the status with [Get account](https://help.withallo.com/en/v2/api-reference/partner/get-account.md).

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`.


## OpenAPI

````yaml POST /v2/api/partner/accounts/{id}/suspend
openapi: 3.0.3
info:
  title: Allo API
  description: >-
    Allo API provides programmatic access to your Allo account, allowing you to
    manage webhooks, retrieve calls and contacts, and send SMS messages.


    All requests to `/v1/api/**` endpoints automatically go through quota
    checking and scope validation.
  version: 1.0.0
  contact:
    name: Allo Support
servers:
  - url: https://api.withallo.com
    description: Production server
security: []
tags:
  - name: Summary Templates
    description: >-
      Manage call summary templates that control how AI-generated call summaries
      are structured for your team.
  - name: Webhooks
    description: >-
      Manage webhook endpoints to receive real-time notifications about events
      in your Allo account. Each endpoint subscribes to one or more event topics
      and is verified with a signing secret.
  - name: Calls
    description: >-
      Retrieve and search call records with filtering and pagination. Filter
      calls by your Allo phone number.
  - name: Contacts
    description: >-
      Search and retrieve contact information with sorting and pagination.
      Includes engagement level tracking.
  - name: SMS
    description: Send SMS messages to phone numbers using your Allo numbers.
  - name: Fax
    description: >-
      Send a PDF as a fax from an Allo line with fax turned on. Sent and
      received faxes appear in conversation items.
  - name: Phone Numbers
    description: Retrieve information about your Allo phone numbers.
  - name: Analytics
    description: Pre-computed call metrics, team performance, and outbound dial funnel
  - name: CRM
    description: Manage people, companies, and deals in your CRM.
  - name: Notes
    description: >-
      Internal team notes on conversations and CRM people, with @mention
      support. Notes are never visible to the contact.
  - name: Threads
    description: >-
      Team discussion threads attached to a conversation item (call, SMS, or
      conversation note). One thread per item.
  - name: AI Receptionist
    description: >-
      Read and write the AI receptionist configuration of a phone line: business
      details, voice, prompt, capabilities, business hours, transfer rules,
      scheduling calendars and knowledge sources.
  - name: Inboxes
    description: >-
      Personal inboxes: saved views of one or more lines, optionally narrowed to
      phone-menu options, with their own filters and notification setting.
paths:
  /v2/api/partner/accounts/{id}/suspend:
    post:
      tags:
        - White label
      summary: Suspend account
      description: >-
        Suspends an account you provisioned, right away. Inbound and outbound
        calls, outgoing SMS and the AI receptionist stop for every member of the
        account: each member's status becomes `SUSPENDED`, and their eSIM lines
        are suspended. The account keeps its numbers, its eSIMs and its history,
        and its billing does not change. Incoming SMS are stored without any
        notification. Idempotent: suspending an account that is already
        suspended changes nothing and sends no second webhook. Allo sends
        `partner.account.suspended` to your webhook endpoint. Requires the
        `PARTNER` scope.
      operationId: suspendPartnerAccount
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The account id returned by Create account (`usr-*`).
      responses:
        '200':
          description: The account, with its new status
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: usr-575966AF3661061265263C58882BC409D2A427B8
                      phone_numbers:
                        type: array
                        items:
                          type: string
                        example:
                          - '+33712345678'
                      status:
                        type: string
                        description: >-
                          The account's status: `ACTIVE`, or `SUSPENDED` while
                          the account is suspended with Suspend account.
                        example: ACTIVE
                      activated:
                        type: boolean
                        description: True once the customer has signed in on a device.
                        example: false
                      partner_client_ref:
                        type: string
                        nullable: true
                        example: crm-12345
              example:
                data:
                  id: usr-575966AF3661061265263C58882BC409D2A427B8
                  phone_numbers:
                    - '+33712345678'
                  status: SUSPENDED
                  activated: true
                  partner_client_ref: crm-12345
        '401':
          $ref: '#/components/responses/ApiUnauthorized'
        '403':
          description: The API key lacks the PARTNER scope.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
        '404':
          description: >-
            No account with this id was provisioned by your API key, or the
            account is deactivated (PARTNER_ACCOUNT_NOT_FOUND).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
        '429':
          $ref: '#/components/responses/ApiRateLimited'
      security:
        - ApiKeyAuth: []
components:
  responses:
    ApiUnauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ApiRateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            request_id:
              type: string
            retry_after_seconds:
              type: integer
              nullable: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.