Remove member
curl --request DELETE \
--url https://api.withallo.com/v2/api/partner/accounts/{id}/members/{member_id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.withallo.com/v2/api/partner/accounts/{id}/members/{member_id}"
headers = {"Authorization": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};
fetch('https://api.withallo.com/v2/api/partner/accounts/{id}/members/{member_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withallo.com/v2/api/partner/accounts/{id}/members/{member_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.withallo.com/v2/api/partner/accounts/{id}/members/{member_id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.withallo.com/v2/api/partner/accounts/{id}/members/{member_id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/partner/accounts/{id}/members/{member_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {}
}{
"error": {}
}{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Members and numbers
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.
DELETE
/
v2
/
api
/
partner
/
accounts
/
{id}
/
members
/
{member_id}
Remove member
curl --request DELETE \
--url https://api.withallo.com/v2/api/partner/accounts/{id}/members/{member_id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.withallo.com/v2/api/partner/accounts/{id}/members/{member_id}"
headers = {"Authorization": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};
fetch('https://api.withallo.com/v2/api/partner/accounts/{id}/members/{member_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withallo.com/v2/api/partner/accounts/{id}/members/{member_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.withallo.com/v2/api/partner/accounts/{id}/members/{member_id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.withallo.com/v2/api/partner/accounts/{id}/members/{member_id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/partner/accounts/{id}/members/{member_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {}
}{
"error": {}
}{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Required scope:
PARTNER204 with no body.
What Allo does
1
Revokes the member's eSIMs
Allo revokes 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.
How to give the number to a new collaborator
Call Add member with the kept number asphone_number. The new member takes it over with its history. See 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. |
PARTNER_ACCOUNT_MEMBER_NOT_FOUND | No member with this id is in the account’s workspace (404). List them with List members. |
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. |
Was this page helpful?