Skip to main content

Update Address​

This API is used to update the address for an existing user.

Path Parameters
  • id string required

    The unique ID of the user address.

Request Body required
  • annotation string required

    Type of address such as home or work.

  • line string required

    The line of the address. Typically the street address, number of the apartment, suite.

  • area string required

    The name of the area in the city.

  • city string required

    The name of the city or district.

  • state string required

    The region of the address, such as the province or state.

  • country string required

    The name of the country.

  • zip string required

    The zip or postal code of the address.

  • landmark string

    The nearest landmark to recognize the address.

  • coordinates number[]

    The two numbers are a location's latitude number and its longitude number.

  • default boolean

    Default value: false

    The default address to use.

  • contact object
  • name string required

    The name of the user.

  • mobile object required
  • code string required

    Unique numeric country code

  • number string required

    The valid phone number of the customer.

Responses

Success response

{
  "statusCode": 200,
  "data": {
    "annotation": "Home",
    "line": "Plot No 52, Balarishna Nagar, 1st Street, Thiruninravur",
    "area": "Thiruninravur",
    "city": "Chennai",
    "state": "Tamil Nadu",
    "country": "India",
    "zip": "602024",
    "landmark": "Near Kamban Park",
    "coordinates": [
      1,
      1
    ],
    "default": false,
    "_id": "632c5839b5f554ad3047e13a"
  }
}