const axios = require('axios');
const OutboxApiFp = require('@alohi/faxplus-api').OutboxApiFp;
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 bulkDeleteOutboxFaxes() {
const reqParams = {
"userId": "self",
"ids": "a1b2c3d4e5f6789012345678901234ab,b2c3d4e5f6789012345678901234abc"
};
const req = await OutboxApiFp(config).bulkDeleteOutboxFaxes(reqParams);
const resp = await req(axios);
}
bulkDeleteOutboxFaxes();
from faxplus import ApiClient, OutboxApi
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 = OutboxApi(api_client)
resp = api.bulk_delete_outbox_faxes(
user_id="self",
ids="a1b2c3d4e5f6789012345678901234ab,b2c3d4e5f6789012345678901234abc",
)
# You can also use wget
curl -X DELETE "https://restapi.fax.plus/v3/accounts/self/outbox?ids=a1b2c3d4e5f6789012345678901234ab,b2c3d4e5f6789012345678901234abc" \
-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'
{
"results": [
{
"id": "<string>",
"code": 204
}
]
}{
"error": "invalid_user_id",
"description": "Invalid user id given"
}{
"error": "unauthorized",
"description": "The access token provided is expired, revoked, malformed, or invalid for other reasons."
}{
"error": "internal_server_error",
"description": "An unexpected error happened, please contact support"
}Outbox
Bulk delete outbox faxes
Bulk delete (cancel) multiple outbox fax records. Maximum 10 outbox fax IDs per request. Duplicate IDs are automatically ignored. (Permitted scopes: fax:all:edit, fax:fax:edit)
DELETE
/
accounts
/
{user_id}
/
outbox
const axios = require('axios');
const OutboxApiFp = require('@alohi/faxplus-api').OutboxApiFp;
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 bulkDeleteOutboxFaxes() {
const reqParams = {
"userId": "self",
"ids": "a1b2c3d4e5f6789012345678901234ab,b2c3d4e5f6789012345678901234abc"
};
const req = await OutboxApiFp(config).bulkDeleteOutboxFaxes(reqParams);
const resp = await req(axios);
}
bulkDeleteOutboxFaxes();
from faxplus import ApiClient, OutboxApi
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 = OutboxApi(api_client)
resp = api.bulk_delete_outbox_faxes(
user_id="self",
ids="a1b2c3d4e5f6789012345678901234ab,b2c3d4e5f6789012345678901234abc",
)
# You can also use wget
curl -X DELETE "https://restapi.fax.plus/v3/accounts/self/outbox?ids=a1b2c3d4e5f6789012345678901234ab,b2c3d4e5f6789012345678901234abc" \
-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'
{
"results": [
{
"id": "<string>",
"code": 204
}
]
}{
"error": "invalid_user_id",
"description": "Invalid user id given"
}{
"error": "unauthorized",
"description": "The access token provided is expired, revoked, malformed, or invalid for other reasons."
}{
"error": "internal_server_error",
"description": "An unexpected error happened, please contact support"
}const axios = require('axios');
const OutboxApiFp = require('@alohi/faxplus-api').OutboxApiFp;
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 bulkDeleteOutboxFaxes() {
const reqParams = {
"userId": "self",
"ids": "a1b2c3d4e5f6789012345678901234ab,b2c3d4e5f6789012345678901234abc"
};
const req = await OutboxApiFp(config).bulkDeleteOutboxFaxes(reqParams);
const resp = await req(axios);
}
bulkDeleteOutboxFaxes();
from faxplus import ApiClient, OutboxApi
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 = OutboxApi(api_client)
resp = api.bulk_delete_outbox_faxes(
user_id="self",
ids="a1b2c3d4e5f6789012345678901234ab,b2c3d4e5f6789012345678901234abc",
)
# You can also use wget
curl -X DELETE "https://restapi.fax.plus/v3/accounts/self/outbox?ids=a1b2c3d4e5f6789012345678901234ab,b2c3d4e5f6789012345678901234abc" \
-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
oauth2personal_access_token
OAuth2 Authorization Grant
Path Parameters
User ID. Use 'self' for your own account, or provide a specific user ID for corporate member accounts.
Query Parameters
Comma-separated list of outbox fax IDs to delete (max 10 unique IDs, each ID is max 32 characters). Duplicates are automatically ignored.
Maximum string length:
400Response
Response containing bulk operation results for outbox faxes
Bulk operation result for outbox faxes
Per-item results for each outbox fax ID
Show child attributes
Show child attributes