Example Request

doc={
    "doctype": "Address",
    "address_type": "Physical",
    "address_status": "Current",
    "country": "United States",
    "payment_type": "No Primary Housing Expense",
    "address_line1": "129",
    "address_line2": "129",
    "city": "Florida",
    "state":"FL",
    "county":"walton",
    "pincode":"75001",
    "is_primary_address": 0,
    "is_shipping_address": 0,
    "disabled": 0,
    "is_your_company_address": 0,
    "links": [
        {
            "idx": 1,
            "link_doctype": "Lead",
            "link_name": "2025-LEAD-07-0000011"
        }
    ]
}&action=Save

Response Explanation

A successful response includes the saved document’s details.

Response Body Parameters

• docs (string)
  A JSON string representation of the created or updated Address document, including all request fields and linkage information. The string contains:

  • doctype (string)
    The type of document, here always "Address".

  • address_type (string)
    The type of address, e.g., "Physical".

  • address_status (string)
    Status of the address, e.g., "Current".

  • country (string)
    Country of the address, e.g., "United States".

  • payment_type (string)
    Indicates housing expense/payment type, e.g., "No Primary Housing Expense".

  • address_line1 (string)
    First line of the address, e.g., "129".

  • address_line2 (string)
    Second line of the address, e.g., "129".

  • city (string)
    City of the address, e.g., "Florida".

  • state (string)
    State abbreviation, e.g., "FL".

  • county (string)
    County, e.g., "walton".

  • pincode (string)
    Postal code/ZIP code, e.g., "75001".

  • is_primary_address (integer)
    Indicates if this is the primary address (0 for false, 1 for true).

  • is_shipping_address (integer)
    Indicates if this is a shipping address (0 for false, 1 for true).

  • disabled (integer)
    Indicates if the address is disabled (0 for false, 1 for true).

  • is_your_company_address (integer)
    Indicates if this is a company address (0 for false, 1 for true).

  • links (array)
    An array of objects showing which document(s) the Address is related to.
    Each object contains:

    • idx (integer) — Array index number.
    • link_doctype (string) — Target document type, e.g., "Lead".
    • link_name (string) — Target document ID, e.g., "2025-LEAD-07-0000011".

  • action (string)
    Value is "Save" indicating the operation performed.

Example Response

{
    "docs": "{     \"doctype\": \"Address\",     \"address_type\": \"Physical\",     \"address_status\": \"Current\",     \"country\": \"United States\",     \"payment_type\": \"No Primary Housing Expense\",     \"address_line1\": \"129\",     \"address_line2\": \"129\",     \"city\": \"Florida\",     \"state\":\"FL\",     \"county\":\"walton\",     \"pincode\":\"75001\",     \"is_primary_address\": 0,     \"is_shipping_address\": 0,     \"disabled\": 0,     \"is_your_company_address\": 0,     \"links\": [         {             \"idx\": 1,             \"link_doctype\": \"Lead\",             \"link_name\": \"2025-LEAD-07-0000011\"         }     ] }&action=Save"
}