v1

latestOpenAPI 3.0.12026-07-266184114.0 KB

Accounts

Modify account information

Modify personal information of your own account or your corporate member's account. user_id can be either self, or a subordinate's user_id. (Permitted scopes: fax:all:edit, fax:member:edit, fax:user:edit)

put/accounts/{user_id}

Path parameters

user_idstring required

User ID to modify. Use 'self' for your own account, or provide a specific user ID for corporate member accounts.

Request body

emailstring

Account email address

lastnamestring

Your last name

namestring

Your first name

phonestring

Your account phone number

profile_imagestring

Profile image path

Example request

{
  "account_data": {
    "default_file_type": "pdf",
    "save_history": true
  },
  "email": "sample@fax.plus",
  "name": "John",
  "lastname": "Smith",
  "notifications": {
    "black_list": {
      "uids": []
    },
    "settings": {
      "email": {
        "addresses": [
          "sample@fax.plus"
        ],
        "low_credit": true,
        "new_feature": true,
        "receive_fax": true,
        "send_fax": true,
        "voicemail": true
      },
      "language": "en",
      "push_notifications": {
        "low_credit": true,
        "new_feature": true,
        "receive_fax": true,
        "send_fax": true,
        "voicemail": true
      },
      "sms": {
        "low_credit": true,
        "new_feature": true,
        "numbers": [
          "+16699990000"
        ],
        "receive_fax": true,
        "send_fax": true,
        "voicemail": true
      }
    }
  },
  "phone": "+16699990000",
  "settings": {
    "caller_id_name": "Fax.Plus",
    "send_fax": {
      "options": {},
      "retry": {
        "count": 0,
        "delay": 0
      },
      "should_enhance": true,
      "default_resolution": "fine",
      "partially_sent_retry": false
    }
  }
}

Response

Modify account information