Update an address - HQ Rental Software

Changes the address fields you send; the ones you leave out keep their values. item_type, item_id, field_id and street are required, but the address stays on its current record. For a contact, its own address fields are refreshed as on create.

An unknown id does not return 404: a new address is created on the record you send instead. Check that address.id is the ID you sent.

Request

Authorization

Path Params

Header Params

Body Params application/jsonRequired

Example

{
    "item_type": "contacts",
    "item_id": 4821,
    "field_id": 45,
    "street": "Main St",
    "housenumber": "120",
    "street2": "Suite 4",
    "suburb": "string",
    "city": "Miami",
    "zip": "33101",
    "state": "FL",
    "country": "US",
    "type": "string",
    "note": "string"
}

Responses

🟢200OK

application/json

The updated address. A successful body has no success field. HTTP 200 is also used for failures: such a body has success: false and is an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "address": {
        "id": 311,
        "item_type": "contacts",
        "item_id": 4821,
        "field_id": 45,
        "street": "Main St",
        "housenumber": "120",
        "street2": "Suite 4",
        "suburb": null,
        "city": "Miami",
        "zip": "33101",
        "state": "FL",
        "country": "US",
        "type": null,
        "note": null,
        "order": 0,
        "country_label": "United States"
    }
}

🟠404Record Not Found

🟠422Parameter Error