Skip to content

Insert or update a Mail2Fax profile

Request

Create a new or update an existing Mail2Fax profile

Security
http-basic-auth
Path
profilestringrequired

The profile name

Example:default
Bodyapplication/jsonrequired

A complete Mail2Fax profile representation

namestring
generalobject(GeneralProfileSettings)
faxobject(FaxSettings)
dialingobject(DialingSettings)
reportEmailobject(ReportEmailSettings)
coverSheetobject(CoverSheetSettings)
personalizationobject
curl -i -X PUT \
  -u '<username>:<password>' \
  https://developers.retarus.com/_mock/fax/fax-config-api/outbound/profiles/default \
  -H 'Content-Type: application/json' \
  -d '{
    "serviceType": "Fax2Mail"
  }'

Responses

Mail2Fax profile updated

Bodyapplication/json
namestring
generalobject(GeneralProfileSettings)
faxobject(FaxSettings)
dialingobject(DialingSettings)
reportEmailobject(ReportEmailSettings)
coverSheetobject(CoverSheetSettings)
personalizationobject
Response
{
  "name": "string",
  "general": {
    "name": "string",
    "active": true,
    "timezone": "string"
  },
  "fax": {
    "csid": "string",
    "costCenter": "string",
    "header": "string",
    "blacklist": true,
    "paperSize": "string",
    "resolution": "string",
    "preferredMimeType": "string",
    "attachmentsOnly": true,
    "suppressBlankPages": true
  },
  "dialing": {
    "countryCode": "string",
    "areaCode": "string"
  },
  "reportEmail": {
    "language": "string",
    "reportFormat": "string",
    "sender": "string",
    "recipients": "string",
    "recipientsIfError": "string",
    "recipientsCc": "string",
    "attachTiff": true,
    "attachTiffOnlyIfError": true,
    "attachPdf": true,
    "sortByStatus": "string",
    "reportRecipients": "string",
    "errorReportRecipients": "string",
    "copyStatusReports": "string"
  },
  "coverSheet": {
    "fileName": "string",
    "dateFormat": "string",
    "timeFormat": "string"
  },
  "personalization": {
    "property1": "string",
    "property2": "string"
  }
}