---
updatedAt: 2026-08-20T16:48:56.000Z
agentTools:
  projectIndex: https://docs.ciiruspartners.com/llms.txt
---

# Update reservation

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "security": [
    {
      "basicAuth": []
    }
  ],
  "info": {
    "title": "CiiRUS Partner API",
    "version": "2024.07.31"
  },
  "paths": {
    "/reservations/{reservation_id}": {
      "put": {
        "summary": "Update reservation",
        "description": "",
        "parameters": [
          {
            "$ref": "#/components/parameters/reservation_id_path"
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/reservation"
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/retrieve_reservation_response"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        },
        "tags": [
          "Reservations"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.ciiruspartners.com/v2024.07.31"
    }
  ],
  "components": {
    "parameters": {
      "reservation_id_path": {
        "name": "reservation_id",
        "in": "path",
        "description": "Unique Identifier for reservation.",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "Bad Request response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Unauthorized response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Forbidden": {
        "description": "Forbidden response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "NotFound": {
        "description": "Not Found response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "requestBodies": {
      "reservation": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/reservation"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    },
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "code",
          "message"
        ]
      },
      "guest_type": {
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "lead_guest",
              "party_member",
              "pet"
            ]
          }
        }
      },
      "payment_type": {
        "properties": {
          "payment_type": {
            "type": "string",
            "enum": [
              "down_payment",
              "scheduled_payment"
            ]
          }
        }
      },
      "payment_method": {
        "properties": {
          "payment_method": {
            "type": "string",
            "enum": [
              "card",
              "check",
              "cash",
              "wire",
              "other",
              "not_specified",
              "journal_entry"
            ]
          }
        }
      },
      "comment_type": {
        "properties": {
          "type": {
            "description": "Type of comment.",
            "type": "string",
            "enum": [
              "private",
              "general",
              "scratch_pad"
            ]
          }
        }
      },
      "payment_status": {
        "properties": {
          "payment_status": {
            "type": "string",
            "enum": [
              "paid",
              "due",
              "scheduled"
            ]
          }
        }
      },
      "unit_id": {
        "properties": {
          "unit_id": {
            "type": "integer",
            "format": "int32",
            "description": "Identifier for unit."
          }
        }
      },
      "unit_name": {
        "properties": {
          "unit_name": {
            "type": "string",
            "description": "Name of the unit."
          }
        }
      },
      "merchant_of_record": {
        "properties": {
          "merchant_of_record": {
            "type": "string",
            "enum": [
              "management_company",
              "agent"
            ],
            "description": "Merchant of record for the unit."
          }
        }
      },
      "management_company_user_id": {
        "properties": {
          "management_company_user_id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique Identifier for supplier"
          }
        }
      },
      "value": {
        "properties": {
          "value": {
            "type": "integer",
            "format": "int64",
            "description": "The value."
          }
        }
      },
      "value_due": {
        "properties": {
          "value_due": {
            "type": "integer",
            "format": "int64",
            "description": "The value due."
          }
        }
      },
      "charge_type": {
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "tax_one",
              "tax_two",
              "tax_three",
              "extra",
              "booking_fee",
              "cleaning_fee",
              "rental",
              "discount_code",
              "pool_heat_fee",
              "security_deposit"
            ],
            "description": "The type of charge."
          }
        }
      },
      "rate_set_id": {
        "properties": {
          "rate_set_id": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "first_name": {
        "properties": {
          "first_name": {
            "type": "string"
          }
        }
      },
      "last_name": {
        "properties": {
          "last_name": {
            "type": "string"
          }
        }
      },
      "currency": {
        "properties": {
          "currency": {
            "type": "string"
          }
        }
      },
      "reservation_creation_old": {
        "allOf": [
          {
            "$ref": "#/components/schemas/unit_id"
          },
          {
            "$ref": "#/components/schemas/reference"
          },
          {
            "$ref": "#/components/schemas/reservation_type"
          },
          {
            "$ref": "#/components/schemas/reservation_details_object"
          },
          {
            "$ref": "#/components/schemas/reservation_financials_object"
          }
        ],
        "required": [
          "type",
          "details"
        ]
      },
      "reservation": {
        "allOf": [
          {
            "$ref": "#/components/schemas/reservation_id_new"
          },
          {
            "$ref": "#/components/schemas/management_company_user_id"
          },
          {
            "$ref": "#/components/schemas/reservation_creation_old"
          },
          {
            "$ref": "#/components/schemas/last_modified"
          },
          {
            "$ref": "#/components/schemas/error_object"
          }
        ]
      },
      "reservation_id_new": {
        "properties": {
          "id": {
            "description": "Unique Identifier for reservation.",
            "type": "integer"
          }
        }
      },
      "reservation_type": {
        "properties": {
          "type": {
            "description": "Indicating the type of reservation.",
            "type": "string",
            "enum": [
              "confirmed",
              "cancelled",
              "tentative"
            ]
          }
        }
      },
      "reservation_details_object": {
        "properties": {
          "details": {
            "description": "Object holding reservation details.",
            "allOf": [
              {
                "$ref": "#/components/schemas/reservation_details"
              }
            ]
          }
        }
      },
      "reservation_financials_object": {
        "properties": {
          "financials": {
            "description": "Object holding reservation financials.",
            "allOf": [
              {
                "$ref": "#/components/schemas/reservation_financials"
              }
            ]
          }
        }
      },
      "reservation_details": {
        "allOf": [
          {
            "$ref": "#/components/schemas/quote_as_super_site_user_id"
          },
          {
            "$ref": "#/components/schemas/arrival"
          },
          {
            "$ref": "#/components/schemas/departure"
          },
          {
            "$ref": "#/components/schemas/added"
          },
          {
            "$ref": "#/components/schemas/expiration"
          },
          {
            "$ref": "#/components/schemas/cancelled_on"
          },
          {
            "$ref": "#/components/schemas/scenario"
          },
          {
            "$ref": "#/components/schemas/comments"
          },
          {
            "$ref": "#/components/schemas/guests"
          },
          {
            "$ref": "#/components/schemas/number_of_adults"
          },
          {
            "$ref": "#/components/schemas/number_of_children"
          },
          {
            "$ref": "#/components/schemas/number_of_pets"
          },
          {
            "$ref": "#/components/schemas/category"
          },
          {
            "$ref": "#/components/schemas/category_id"
          },
          {
            "$ref": "#/components/schemas/category_description"
          },
          {
            "$ref": "#/components/schemas/calendar_sync_category_id"
          },
          {
            "$ref": "#/components/schemas/secure_details"
          },
          {
            "$ref": "#/components/schemas/early_check_in"
          },
          {
            "$ref": "#/components/schemas/late_check_out"
          },
          {
            "$ref": "#/components/schemas/arrival_departure_info"
          },
          {
            "$ref": "#/components/schemas/owner_reservation"
          },
          {
            "$ref": "#/components/schemas/source"
          },
          {
            "$ref": "#/components/schemas/thread_id"
          },
          {
            "$ref": "#/components/schemas/airbnb_confirmation_code"
          },
          {
            "$ref": "#/components/schemas/unit_name"
          },
          {
            "$ref": "#/components/schemas/referrer"
          }
        ],
        "required": [
          "arrival",
          "departure",
          "guests"
        ]
      },
      "reservation_financials": {
        "allOf": [
          {
            "$ref": "#/components/schemas/rate_set_id"
          },
          {
            "$ref": "#/components/schemas/length_of_stay"
          },
          {
            "$ref": "#/components/schemas/pool_heat"
          },
          {
            "$ref": "#/components/schemas/discount_code"
          },
          {
            "$ref": "#/components/schemas/currency"
          },
          {
            "$ref": "#/components/schemas/merchant_of_record"
          },
          {
            "$ref": "#/components/schemas/merchant_of_record_user"
          },
          {
            "$ref": "#/components/schemas/charges"
          },
          {
            "$ref": "#/components/schemas/payments"
          },
          {
            "$ref": "#/components/schemas/payment_schedule"
          },
          {
            "$ref": "#/components/schemas/total_paid"
          },
          {
            "$ref": "#/components/schemas/total_value"
          },
          {
            "$ref": "#/components/schemas/payment_taken_by"
          },
          {
            "$ref": "#/components/schemas/merchant_grantee_agent"
          },
          {
            "$ref": "#/components/schemas/merchant_grantee_supplier"
          },
          {
            "$ref": "#/components/schemas/amount_paid"
          },
          {
            "$ref": "#/components/schemas/mc_total_inclusive_tax"
          },
          {
            "$ref": "#/components/schemas/balance_due_amount"
          },
          {
            "$ref": "#/components/schemas/balance_due_date"
          }
        ]
      },
      "quote_as_super_site_user_id": {
        "properties": {
          "quote_as_super_site_user_id": {
            "description": "Pass this to quote as a specific user id.",
            "type": "integer"
          }
        }
      },
      "amount": {
        "properties": {
          "amount": {
            "type": "integer"
          }
        }
      },
      "number_of_adults": {
        "properties": {
          "number_of_adults": {
            "description": "The number of adults.",
            "type": "integer"
          }
        }
      },
      "number_of_children": {
        "properties": {
          "number_of_children": {
            "description": "The number of children.",
            "type": "integer"
          }
        }
      },
      "number_of_pets": {
        "properties": {
          "number_of_pets": {
            "description": "The number of pets.",
            "type": "integer"
          }
        }
      },
      "category_description": {
        "properties": {
          "category_description": {
            "description": "Internal category name.",
            "type": "string"
          }
        }
      },
      "calendar_sync_category_id": {
        "properties": {
          "calendar_sync_category_id": {
            "description": "Category Id for calendar sync agent.",
            "type": "integer"
          }
        }
      },
      "source": {
        "properties": {
          "source": {
            "description": "Source of reservation.",
            "type": "string"
          }
        }
      },
      "thread_id": {
        "properties": {
          "thread_id": {
            "description": "Identifier for message thread.",
            "type": "string"
          }
        }
      },
      "airbnb_confirmation_code": {
        "properties": {
          "airbnb_confirmation_code": {
            "description": "Identified for airbnb reservation.",
            "type": "string"
          }
        }
      },
      "referrer": {
        "properties": {
          "referrer": {
            "description": "Referrer for the reservation.",
            "type": "string"
          }
        }
      },
      "length_of_stay": {
        "properties": {
          "length_of_stay": {
            "description": "Indicating if length of stay rates are desired/included.",
            "type": "boolean"
          }
        }
      },
      "pool_heat": {
        "properties": {
          "pool_heat": {
            "description": "Indicating if pool heat is desired/included.",
            "type": "boolean"
          }
        }
      },
      "discount_code": {
        "properties": {
          "discount_code": {
            "type": "string"
          }
        }
      },
      "merchant_of_record_user": {
        "properties": {
          "merchant_of_record_user": {
            "type": "integer"
          }
        }
      },
      "arrival": {
        "properties": {
          "arrival": {
            "description": "Arrival date-time.",
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "departure": {
        "properties": {
          "departure": {
            "description": "Departure date-time.",
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "added": {
        "properties": {
          "added": {
            "description": "Added date-time.",
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "reference": {
        "properties": {
          "reference": {
            "description": "Reference for resevation.",
            "type": "string"
          }
        }
      },
      "last_modified": {
        "properties": {
          "last_modified": {
            "description": "Timestamp indicating last modification.",
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "expiration": {
        "properties": {
          "expiration": {
            "description": "When the quote or tentaive reservation expires.",
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "cancelled_on": {
        "properties": {
          "cancelled_on": {
            "description": "When the reservation was cancelled.",
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "owner_reservation": {
        "properties": {
          "owner_reservation": {
            "description": "If this is an owner reservation or not.",
            "type": "boolean"
          }
        }
      },
      "payment_item2": {
        "allOf": [
          {
            "$ref": "#/components/schemas/amount"
          },
          {
            "$ref": "#/components/schemas/payment_date"
          },
          {
            "$ref": "#/components/schemas/amount_decimal_places"
          },
          {
            "$ref": "#/components/schemas/payment_user_id"
          },
          {
            "$ref": "#/components/schemas/payment_method"
          },
          {
            "$ref": "#/components/schemas/payment_type"
          },
          {
            "$ref": "#/components/schemas/payment_description"
          }
        ]
      },
      "payments": {
        "properties": {
          "payments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/payment_item2"
            }
          }
        }
      },
      "payment_schedule_item": {
        "allOf": [
          {
            "$ref": "#/components/schemas/value"
          },
          {
            "$ref": "#/components/schemas/value_due"
          },
          {
            "$ref": "#/components/schemas/payment_type"
          },
          {
            "$ref": "#/components/schemas/payment_status"
          },
          {
            "$ref": "#/components/schemas/due_date"
          }
        ]
      },
      "payment_date": {
        "properties": {
          "payment_date": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "payment_user_id": {
        "properties": {
          "payment_user_id": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "payment_description": {
        "properties": {
          "payment_description": {
            "type": "string"
          }
        }
      },
      "due_date": {
        "properties": {
          "due_date": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "payment_schedule": {
        "properties": {
          "payment_schedule": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/payment_schedule_item"
            }
          }
        }
      },
      "comments": {
        "properties": {
          "comments": {
            "description": "Object holding reservation comments.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/comment"
            }
          }
        }
      },
      "comment": {
        "properties": {
          "text": {
            "type": "string",
            "description": "Comment text."
          }
        },
        "allOf": [
          {
            "$ref": "#/components/schemas/comment_type"
          }
        ]
      },
      "total_value": {
        "properties": {
          "total_value": {
            "type": "integer",
            "format": "int64",
            "description": "The total value of this booking."
          }
        }
      },
      "total_paid": {
        "properties": {
          "total_paid": {
            "type": "integer",
            "format": "int64",
            "description": "The total amount paid by the customer."
          }
        }
      },
      "payment_taken_by": {
        "properties": {
          "payment_taken_by": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "merchant_grantee_agent": {
        "properties": {
          "merchant_grantee_agent": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "merchant_grantee_supplier": {
        "properties": {
          "merchant_grantee_supplier": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "amount_decimal_places": {
        "properties": {
          "amount_decimal_places": {
            "type": "integer",
            "default": 2,
            "minimum": 1,
            "description": "The number of decimal places to represent the amount as."
          }
        }
      },
      "amount_paid": {
        "properties": {
          "amount_paid": {
            "type": "integer",
            "description": "The total amount paid."
          }
        }
      },
      "mc_total_inclusive_tax": {
        "properties": {
          "mc_total_inclusive_tax": {
            "type": "integer",
            "description": "The total amount inclusive tax."
          }
        }
      },
      "balance_due_amount": {
        "properties": {
          "balance_due_amount": {
            "type": "integer",
            "description": "The balance due that is mc_total_inclusive_tax-amount_paid."
          }
        }
      },
      "balance_due_date": {
        "properties": {
          "balance_due_date": {
            "type": "string",
            "format": "date-time",
            "description": "The balance due date."
          }
        }
      },
      "charges": {
        "properties": {
          "charges": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/charge"
            }
          }
        }
      },
      "charge": {
        "properties": {
          "item": {
            "type": "string"
          },
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "code": {
            "type": "string"
          },
          "applies_to_id": {
            "type": "string"
          },
          "quantity": {
            "type": "integer"
          }
        },
        "allOf": [
          {
            "$ref": "#/components/schemas/charge_type"
          },
          {
            "$ref": "#/components/schemas/value"
          }
        ]
      },
      "arrival_departure_info": {
        "properties": {
          "arrival_departure_info": {
            "type": "string"
          }
        }
      },
      "secure_details": {
        "properties": {
          "secure_details": {
            "$ref": "#/components/schemas/secure_detail"
          }
        }
      },
      "secure_detail": {
        "allOf": [
          {
            "$ref": "#/components/schemas/lock_box_code"
          },
          {
            "$ref": "#/components/schemas/gate_code"
          },
          {
            "$ref": "#/components/schemas/alarm_code"
          },
          {
            "$ref": "#/components/schemas/wifi_ssid"
          },
          {
            "$ref": "#/components/schemas/wifi_password"
          },
          {
            "$ref": "#/components/schemas/lobby_code"
          },
          {
            "$ref": "#/components/schemas/fitness_room_code"
          },
          {
            "$ref": "#/components/schemas/pool_access_code"
          },
          {
            "$ref": "#/components/schemas/beach_access_code"
          },
          {
            "$ref": "#/components/schemas/door_code"
          }
        ]
      },
      "lock_box_code": {
        "properties": {
          "lock_box_code": {
            "description": "Code for lock box access.",
            "type": "string"
          }
        }
      },
      "gate_code": {
        "properties": {
          "gate_code": {
            "description": "Code for gate access.",
            "type": "string"
          }
        }
      },
      "alarm_code": {
        "properties": {
          "alarm_code": {
            "description": "Code for alarm access.",
            "type": "string"
          }
        }
      },
      "wifi_ssid": {
        "properties": {
          "wifi_ssid": {
            "description": "Wifi network name.",
            "type": "string"
          }
        }
      },
      "wifi_password": {
        "properties": {
          "wifi_password": {
            "description": "Wifi password.",
            "type": "string"
          }
        }
      },
      "lobby_code": {
        "properties": {
          "lobby_code": {
            "description": "Code for lobby access.",
            "type": "string"
          }
        }
      },
      "fitness_room_code": {
        "properties": {
          "fitness_room_code": {
            "description": "Code for fitness room access.",
            "type": "string"
          }
        }
      },
      "pool_access_code": {
        "properties": {
          "pool_access_code": {
            "description": "Code for pool access.",
            "type": "string"
          }
        }
      },
      "beach_access_code": {
        "properties": {
          "beach_access_code": {
            "description": "Code for beach access.",
            "type": "string"
          }
        }
      },
      "door_code": {
        "properties": {
          "door_code": {
            "description": "Code for door access.",
            "type": "string"
          }
        }
      },
      "category_id": {
        "properties": {
          "category_id": {
            "description": "The reservation category_id.",
            "type": "integer"
          }
        }
      },
      "category": {
        "properties": {
          "category": {
            "description": "The reservation category name.",
            "type": "string"
          }
        }
      },
      "scenario": {
        "properties": {
          "scenario": {
            "description": "The reservation viewing scenario.",
            "type": "integer"
          }
        }
      },
      "guests": {
        "properties": {
          "guests": {
            "description": "Object holding guests.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/guest"
            }
          }
        }
      },
      "early_check_in": {
        "properties": {
          "early_check_in": {
            "description": "Reservation early check in is desired/included.",
            "type": "boolean"
          }
        }
      },
      "late_check_out": {
        "properties": {
          "late_check_out": {
            "description": "Reservation late check out is desired/included.",
            "type": "boolean"
          }
        }
      },
      "guest": {
        "allOf": [
          {
            "$ref": "#/components/schemas/guest_id"
          },
          {
            "$ref": "#/components/schemas/guest_type"
          },
          {
            "$ref": "#/components/schemas/title"
          },
          {
            "$ref": "#/components/schemas/first_name"
          },
          {
            "$ref": "#/components/schemas/last_name"
          },
          {
            "$ref": "#/components/schemas/age"
          },
          {
            "$ref": "#/components/schemas/phone_numbers"
          },
          {
            "$ref": "#/components/schemas/email_addresses"
          },
          {
            "$ref": "#/components/schemas/customer_address"
          },
          {
            "$ref": "#/components/schemas/notes"
          },
          {
            "$ref": "#/components/schemas/allow_marketing_emails"
          },
          {
            "$ref": "#/components/schemas/airbnb_guest_id"
          }
        ],
        "required": [
          "type",
          "first_name",
          "last_name"
        ]
      },
      "customer_address": {
        "properties": {
          "address": {
            "$ref": "#/components/schemas/address"
          }
        }
      },
      "guest_id": {
        "properties": {
          "id": {
            "description": "CRM id of the guest.",
            "type": "integer"
          }
        }
      },
      "title": {
        "properties": {
          "title": {
            "description": "Title of the guest.",
            "type": "string"
          }
        }
      },
      "age": {
        "properties": {
          "age": {
            "description": "Age of the guest.",
            "type": "string"
          }
        }
      },
      "phone_numbers": {
        "properties": {
          "phone_numbers": {
            "description": "Guest phone numbers.",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "email_addresses": {
        "properties": {
          "email_addresses": {
            "description": "Guest email addresses.",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "notes": {
        "properties": {
          "notes": {
            "description": "Notes about the guest.",
            "type": "string"
          }
        }
      },
      "allow_marketing_emails": {
        "properties": {
          "allow_marketing_emails": {
            "description": "Whether to allow CRM marketing emails or not.",
            "type": "boolean"
          }
        }
      },
      "airbnb_guest_id": {
        "properties": {
          "airbnb_guest_id": {
            "description": "Airbnb reservation guest id.",
            "type": "string"
          }
        }
      },
      "retrieve_reservation_response": {
        "allOf": [
          {
            "$ref": "#/components/schemas/reservation"
          },
          {
            "type": "object"
          }
        ]
      },
      "error_object": {
        "properties": {
          "error": {
            "$ref": "#/components/schemas/error"
          }
        }
      },
      "error": {
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message."
          }
        }
      },
      "address": {
        "properties": {
          "address_line_1": {
            "type": "string"
          },
          "address_line_2": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "state_province": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "postal_code": {
            "type": "string"
          }
        },
        "required": [
          "address_line_1",
          "city",
          "state_province",
          "country",
          "postal_code"
        ]
      }
    }
  }
}
```