POST /v1/entity/fax

NOTE: This method is not accessible to users on Starter Plan API keys. Please contact us if you want premium access to our service

HTTP Method: POST

Path:  /v1/entity/fax

Authentication: API Key required, User ID required

Description: upload a fax number  for an entity

Parameters:

 

Parameter Type Mandatory Description Example
api_key string yes the user API key b66qw3edr56thhg
_user_id string yes The user user_id ax34er6tt65edr
entity_id string yes The entity ID being manipulated
379275323781120
number string yes the phone number to be added 020 3492345  or +44 20 8445 6789
description
string no Display name for the fax
"Sales Office"

 

Sample Success Response:

{
    "success": true,
    "msg": "ok",
    "data": {
        "ok": true,
        "id": "379275323781120",
        "rev": "29-f8659797282cbbfffa92c20731486e38"
    }
}  

Docs Navigation