Skip to content

Update a single inbound fax number

Request

Update a single inbound fax number. Any omitted fields are automatically defaulted to null, where null is equivalent to Default ie the value will be inherited from the assigned profile.

Security
http-basic-auth
Path
numberstringrequired

The inbound fax number

Example:+498900000000
Bodyapplication/jsonrequired

A list of recipient email addresses, for now

One of:
displayNumberstring

The display number is used in the meta provided to the user or application, and in reporting. If it is null, the actual number will be used.

commentsstring
faxIdstring

CSID

costCenterstring
activeboolean

If the number should be active or not. If it is not active, when the number is called the repsonse will be wrong number.

curl -i -X PUT \
  -u '<username>:<password>' \
  'https://developers.retarus.com/_mock/fax/fax-config-api/inbound/numbers/+498900000000' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": {
      "recipients": [
        "john.smith@acme.com"
      ]
    }
  }'

Responses

Successful

Response
No content