Patch a single outbound fax profile

Request

Patch a single outbound fax profile. #FIXME this description

Security

http-basic-auth

Path

profilestringrequired

The profile name

Example:default

Bodyapplication/jsonrequired

A json patch object according to RFC 6902

Array [

opstringrequired

The operation to be performed

Enum:"add""remove""replace""move""copy""test"

pathstringrequired

A JSON-Pointer

valueobject

The value to be used within the operations.

fromstring

A string containing a JSON Pointer value.

]

curl -i -X PATCH \
  -u '<username>:<password>' \
  https://developers.retarus.com/_mock/fax/fax-config-api/outbound/profiles/default \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": {},
      "from": "string"
    }
  ]'

Responses

Voilà

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"
  }
}