Skip to content

Create an inbound fax profile

Request

Create an inbound fax profile.

Security
http-basic-auth
Path
profilestringrequired
Example:FaxToEmail-USA
Bodyapplication/jsonrequired

A complete profile representation

serviceTypestring(InboundProfileServiceType)
Enum:"Fax2Mail""Fax2WS""Fax2FTP"
curl -i -X PUT \
  -u '<username>:<password>' \
  https://developers.retarus.com/_mock/fax/fax-config-api/inbound/profiles/FaxToEmail-USA \
  -H 'Content-Type: application/json' \
  -d '{
    "serviceType": "Fax2Mail"
  }'

Responses

Inbound fax profile updated

Bodyapplication/json
namestring
serviceTypestring(InboundProfileServiceType)
Enum:"Fax2Mail""Fax2WS""Fax2FTP"
Response
{
  "name": "FaxToEmail-USA",
  "serviceType": "Fax2Mail"
}