Update an existing fax_machine

This action will update an existing fax machine matching the given ID.

Try this request in your browser

/api/ /fax_machines/update

Headers

X-Auth-App
X-Auth-Token
X-Auth-Secret
X-Auth-Extension
X-Auth-Password
X-Proxy-Auth-Token
X-Proxy-Auth-Secret

Parameters

id String
name String
email_address String 

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/fax_machines/update

Access

Must be authenticated as a user or API token. If not authorised, a AccessDenied error will be returned.

Parameters

Parameter Type Default

id Required

The ID of the fax machine

 String null

name

The name

 String null

email_address

The e-mail address faxes will be sent to

 String null

Errors

Error Attributes

FaxMachineNotFound

No fax machine was found given the ID provided

  • id

    The provided UUID

NoAccessToFaxMachine

Your authenticated identity is not permitted to access this fax machine

ValidationError

A validation error occurred

  • errors

    An array of errors

Response Data

This action will return a fax machine structure.

You'll receive all attributes for this structure (basic and extended attributes). You'll receive all expansions for this stucture.