This defines the Sub User API:
A Fax API request looks like:
https://fax.to/api/v2/subuser?api_key=API_KEY
This request contains:
The following table shows the parameters you use in the request:
Parameter | Description | Required |
---|---|---|
The unique email id of the subuser. | Yes | |
password | The password of the subuser | No |
The following table shows the information for authentication:
Parameter | Description | Required |
---|---|---|
api_key | Your Key. For example, api_key=f@x2r0ckkz . |
Yes. |
You find your Key in Dashboard.
To ensure privacy, you must use HTTPS for all Faxto API requests.
You submit all requests with a POST call using UTF-8 encoding and URL encoded values.
We support JSON ONLY responses
{
"status": "success",
"api_key": "94a126a0-9940-11e7-ac09-f55a41e16868"
}
Key | Value | Response Type |
---|---|---|
status | The status of the API request | JSON |
api_key | The API key of the subuser | JSON |
HTTP Status Code | Reason |
---|---|
200 | Successful response |
401 | Unauthorized. |
403 | Rate limit exceeded |
404 | Resource not Found |
500 | Internal server error |