Skip to main content
DELETE
/
accounts
/
{user_id}
/
numbers
/
{number}
const axios = require('axios');
const NumbersApiFp = require('@alohi/faxplus-api').NumbersApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    // Header required only when using the OAuth2 token scheme
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function revokeNumber() {
    const reqParams = {
        "userId": '23415ufasx8df7',
        "number": '+123417543010'
    }
    const req = await NumbersApiFp(config).revokeNumber(reqParams);
    const resp = await req(axios);
}

revokeNumber()
from faxplus import ApiClient, NumbersApi
from faxplus.configuration import Configuration

conf = Configuration()
conf.access_token = access_token
# header_name and header_value required only when using the OAuth2 token scheme
api_client = ApiClient(header_name='x-fax-clientid', header_value=client_id, configuration=conf)
api = NumbersApi(api_client)
api.revoke_number(
    user_id='23415ufasx8df7',
    number='+123417543010')
/**
 * Example below uses Apache HTTP Client 4 with Fluent API
 **/

Map<String, String> pathParams = new HashMap<>();
pathParams.put("user_id", "'23415ufasx8df7'");
pathParams.put("number", "'+123417543010'");

StrSubstitutor sub = new StrSubstitutor(values, "{", "}");
String url = sub.replace("https://restapi.fax.plus/v3/accounts/{user_id}/numbers/{number}");

String result = Request
    .Delete(url)
     // The x-fax-clientid header is required only when using the OAuth2 token scheme
    .addHeader("x-fax-clientid", "YOUR CLIENT_ID")
    .addHeader("Accept", "'application/json'")
    .addHeader("Authorization", "'Bearer {access-token}'")
    .execute()
    .returnContent().asString();

System.out.println(result.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        // The x-fax-clientid header is required only when using the OAuth2 token scheme
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        "x-fax-clientid": []string{"YOUR CLIENT_ID"}
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://restapi.fax.plus/v3/accounts/{user_id}/numbers/{number}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    // The x-fax-clientid header is required only when using the OAuth2 token scheme
    'x-fax-clientid' => '{client ID}',
);

$client = new GuzzleHttp\Client();

try {
    $response = $client->request('DELETE','https://restapi.fax.plus/v3/accounts/{user_id}/numbers/{number}', array(
        'headers' => $headers,
        )
    );
    print_r($response->getBody()->getContents());
 }
 catch (GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
# You can also use wget
curl -X DELETE https://restapi.fax.plus/v3/accounts/{user_id}/numbers/{number} \
  -H 'Accept: application/json'  \
  -H 'Authorization: Bearer {access-token}' \
  # The x-fax-clientid header is required only when using the OAuth2 token scheme
  -H 'x-fax-clientid: "YOUR CLIENT_ID"'
{
  "error": "invalid_user_id",
  "description": "Invalid user id given"
}
{
"error": "internal_server_error",
"description": "An unexpected error happened, please contact support"
}
const axios = require('axios');
const NumbersApiFp = require('@alohi/faxplus-api').NumbersApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    // Header required only when using the OAuth2 token scheme
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function revokeNumber() {
    const reqParams = {
        "userId": '23415ufasx8df7',
        "number": '+123417543010'
    }
    const req = await NumbersApiFp(config).revokeNumber(reqParams);
    const resp = await req(axios);
}

revokeNumber()
from faxplus import ApiClient, NumbersApi
from faxplus.configuration import Configuration

conf = Configuration()
conf.access_token = access_token
# header_name and header_value required only when using the OAuth2 token scheme
api_client = ApiClient(header_name='x-fax-clientid', header_value=client_id, configuration=conf)
api = NumbersApi(api_client)
api.revoke_number(
    user_id='23415ufasx8df7',
    number='+123417543010')
/**
 * Example below uses Apache HTTP Client 4 with Fluent API
 **/

Map<String, String> pathParams = new HashMap<>();
pathParams.put("user_id", "'23415ufasx8df7'");
pathParams.put("number", "'+123417543010'");

StrSubstitutor sub = new StrSubstitutor(values, "{", "}");
String url = sub.replace("https://restapi.fax.plus/v3/accounts/{user_id}/numbers/{number}");

String result = Request
    .Delete(url)
     // The x-fax-clientid header is required only when using the OAuth2 token scheme
    .addHeader("x-fax-clientid", "YOUR CLIENT_ID")
    .addHeader("Accept", "'application/json'")
    .addHeader("Authorization", "'Bearer {access-token}'")
    .execute()
    .returnContent().asString();

System.out.println(result.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        // The x-fax-clientid header is required only when using the OAuth2 token scheme
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        "x-fax-clientid": []string{"YOUR CLIENT_ID"}
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://restapi.fax.plus/v3/accounts/{user_id}/numbers/{number}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    // The x-fax-clientid header is required only when using the OAuth2 token scheme
    'x-fax-clientid' => '{client ID}',
);

$client = new GuzzleHttp\Client();

try {
    $response = $client->request('DELETE','https://restapi.fax.plus/v3/accounts/{user_id}/numbers/{number}', array(
        'headers' => $headers,
        )
    );
    print_r($response->getBody()->getContents());
 }
 catch (GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
# You can also use wget
curl -X DELETE https://restapi.fax.plus/v3/accounts/{user_id}/numbers/{number} \
  -H 'Accept: application/json'  \
  -H 'Authorization: Bearer {access-token}' \
  # The x-fax-clientid header is required only when using the OAuth2 token scheme
  -H 'x-fax-clientid: "YOUR CLIENT_ID"'

Authorizations

Authorization
string
header
required

OAuth2 Authorization Grant

Path Parameters

user_id
string
default:self
required

ID of the user to revoke the number from. Use 'self' for your own account, or provide a specific user ID for corporate member accounts. Number cannot be removed from the admin.

number
string
required

Fax number to remove members from

Response

Revoke number from member that owns fax number