Delete insured address by alias

📘

API Refs

URI Parameters

NameTypeDescriptionRequired
userIdnumberinsure idyes
aliasstringName of insured’s address informationyes

Example

  1. Get list of insured’s addresses Request with userId = 1;
  2. Get list of insured’s addresses Response:
    [
      {
        "address1": "11 Birch Hill Street",
        "address2": "Apt. 123",
        "city": "Bronx",
        "postalCode": "10023",
        "state": "NY",
        "phone": "123-456-7890",
        "alias": "Home"
      },
      {
        "address1": "9234 Bank Avenue",
        "address2": "Apt. 04",
        "city": "Corona",
        "postalCode": "11368",
        "state": "NY",
        "phone": "123-456-7890",
        "alias": "Office"
      }
    ]
    
  3. Delete insured address by alias Request with alias = “Office”;
  4. Get list of insured’s addresses Request with userId = 1;
  5. Get list of insured’s addresses Response:
    [
      {
        "address1": "11 Birch Hill Street",
        "address2": "Apt. 123",
        "city": "Bronx",
        "postalCode": "10023",
        "state": "NY",
        "phone": "123-456-7890",
        "alias": "Home"
      }
    ]
    

Description

📘

Where to get address alias?

You can get all existing addresses with their alias for any you insured. Go to Get list of insured’s addresses for more information about it.

If your insured's address is outdated or no longer in use, you can delete it.
To remove an address, you must provide its alias in the request parameters.
Once deleted, the alias and primary address values are no longer usable and you can add them with a new address, or change one of the remaining ones.