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

# Remove member

> Removes a member from one of your accounts. Allo revokes the member's eSIMs first, so their phone stops ringing right away, then removes the member from the account's workspace. The member's numbers stay on the account, with their history. The seat stays paid until the end of the current billing period, and from the next invoice the account's subscription bills the kept numbers as extra numbers, with no proration. Requires the `PARTNER` scope.

> [!NOTE]
>
> **Required scope:** `PARTNER`

Removes a member from one of your accounts, for example when a collaborator leaves your customer's company. The member's numbers stay on the account with their history, so you can give them to the collaborator who replaces them. The response is `204` with no body.

## What Allo does

**1. Revokes the member's eSIMs**

Allo [revokes](https://help.withallo.com/en/v2/api-reference/white-label/revoke-esim.md) every eSIM the member holds, and every eSIM on their numbers (including one ordered without `holder_id`), before anything else, so their phone stops ringing right away, even if a later step fails. Each eSIM's data tier ends now.

**2. Removes the member from the workspace**

The member loses access to the account's workspace. Their numbers move to the account itself, with their call and message history, and ring the Allo apps.

**3. Swaps the seat for extra numbers**

The member's seat stays paid until the end of the current billing period. From the next invoice, the account's subscription bills the kept numbers as extra numbers instead of the seat, with no proration. Allo only adds the extra numbers the account does not already pay for.

If the account is being deactivated at the end of its billing period, Allo bills nothing more for the kept numbers.

## How to give the number to a new collaborator

Call [Add member](https://help.withallo.com/en/v2/api-reference/white-label/add-member.md) with the kept number as `phone_number`. The new member takes it over with its history. See [How to replace a collaborator who leaves](https://help.withallo.com/en/v2/api-reference/white-label/overview.md#how-to-replace-a-collaborator-who-leaves) for the full flow, including a new eSIM.

## Errors

| Code | What it means |
| - | - |
| `PARTNER_ACCOUNT_OWNER_NOT_REMOVABLE` | `member_id` is the account itself, which is not a member (`400`). To end the account, use [Deactivate account](https://help.withallo.com/en/v2/api-reference/partner/delete-account.md). |
| `PARTNER_ACCOUNT_MEMBER_NOT_FOUND` | No member with this id is in the account's workspace (`404`). List them with [List members](https://help.withallo.com/en/v2/api-reference/white-label/list-members.md). |
| `PARTNER_ACCOUNT_NOT_FOUND` | Your API key did not create this account, or the account is deactivated (`404`). |
| `PARTNER_ESIM_MOVE_IN_PROGRESS` | One of the member's eSIMs is being moved between the network and the eSIM right now (`409`). Always `retryable: true`: retry in a few minutes. Nothing was changed. |
| `PARTNER_ESIM_MOVE_FAILED` | One of the member's eSIMs failed to move between the network and the eSIM (`409`). Contact Allo support. Nothing was changed. |
| `PARTNER_ACCOUNT_BUSY` | Another member or number is being changed on this account right now (`409`). Always `retryable: true`: retry in a few seconds. |


## OpenAPI

````yaml DELETE /v2/api/partner/accounts/{id}/members/{member_id}
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}/members/{member_id}:
    delete:
      tags:
        - White label
      summary: Remove member
      description: >-
        Removes a member from one of your accounts. Allo revokes the member's
        eSIMs first, so their phone stops ringing right away, then removes the
        member from the account's workspace. The member's numbers stay on the
        account, with their history. The seat stays paid until the end of the
        current billing period, and from the next invoice the account's
        subscription bills the kept numbers as extra numbers, with no proration.
        Requires the `PARTNER` scope.
      operationId: removePartnerAccountMember
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The account id returned by Create account (`usr-*`).
        - name: member_id
          in: path
          required: true
          schema:
            type: string
          description: The member's `id` (`usr-*`), from Add member or List members.
      responses:
        '204':
          description: Member removed
        '400':
          description: >-
            The `member_id` is the account itself, which is not a member
            (PARTNER_ACCOUNT_OWNER_NOT_REMOVABLE). To end the account, use
            `DELETE /v2/api/partner/accounts/{id}`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
        '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), or no member
            with this id is in the account's workspace
            (PARTNER_ACCOUNT_MEMBER_NOT_FOUND).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
        '409':
          description: >-
            One of the member's eSIMs is being moved between the network and the
            eSIM right now (PARTNER_ESIM_MOVE_IN_PROGRESS), or another member or
            number is being changed on this account (PARTNER_ACCOUNT_BUSY). Both
            are `retryable: true`: retry in a few minutes for the first, a few
            seconds for the second.
          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.