FAfax
Contacts

Create a contact

Create a new contact (Permitted scopes: fax:all:edit)

post/accounts/self/contacts

Request

  • Base URL
    https://restapi.fax.plus/v3
  • URL
    https://restapi.fax.plus/v3/accounts/self/contacts
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all
      Token URL: https://accounts.fax.plus/token scopes: all

Request body

namestring required

Contact name

fax_numberstring required

Contact's fax number

emailstring

Contact's email address

cellphonestring

Contact's cellphone number

phonestring

Contact's phone number

notesstring

Additional notes

groupsstring[]

List of group names

is_telefaxboolean

Whether this contact has a human fax operator. When enabled, an IVR will ask the operator to switch to fax mode

sharedboolean

Whether to share contact with corporate members

Example request

{
  "name": "John Doe",
  "fax_number": "+12025551234",
  "email": "john.doe@example.com",
  "cellphone": "+12025551235",
  "phone": "+12025551236",
  "notes": "Prefers email communication",
  "groups": [
    "sales",
    "department 001"
  ]
}

Response

Contact created successfully

Changes

No recorded changes to this operation across all 2 revisions of this API.