How to Assign Fax Numbers Using the Fax.Plus API?

Overview

This guide explains how to assign fax numbers to corporate users through the Fax.Plus API. You'll learn how to list corporate members, assign numbers to specific users, and revoke number assignments when needed.

Prerequisites

• An active Fax.Plus Enterprise account
• Valid API credentials
• Two or more fax numbers in your account

Step-by-Step Guide

1. List corporate members
   First, retrieve a list of all members in your corporate account. This endpoint can be accessed only by Admin accounts.
   GET /v3/accounts

{
"members": [
{
"account_data": {
"company_name": "Company name",
"default_file_type": "pdf",
"save_history": true
},
"account_type": "corporate_admin",
"email": "John@sample.com",
"lastname": "Smith",
"status": "active",
"uid": "7724157c0974440293e45877c57f0703"
}
]
}Important: Note down the UIDof the member you want to assign the number to. You'll need this in the next step.
   Learn more: List corporate members - Fax.Plus API
2. Assign a number to the user
   Once you have the user's UIU, you can assign a fax number to them using the following endpoint:
   POST /v3/accounts/self/numbers/{number}
   Request body:
   {
"assigned_to": "<uid>"
}Replace {number} in the URL with the actual fax number you want to assign, and the assigned_tovalue with the user's UIU.
   Learn more: Assign number - Fax.Plus API
3. Revoke number assignment
   If you need to remove a number assignment from a user, use this endpoint:
   DELETE /v3/accounts/{user_id}/numbers/{number}
   Learn more: Revoke number - Fax.Plus API
   Parameters:
   
   • user_idID of the user to revoke the number from
   • numberFax number to remove from the user

Troubleshooting

Common issues and solutions

1. 403 Forbidden Error
   
   • Cause: Insufficient permissions or non-admin account
   • Solution: Verify you're using an admin account and have the required API scopes
2. 404 Not Found Error
   • Cause: Invalid user ID or fax number
   • Solution: Double-check the user ID and fax number are correct
3. 400 Bad Request Error
   • Cause: Invalid request format or attempting to remove a number from admin
   • Solution: Verify request format and ensure you're not trying to remove numbers from admin accounts