PATCH /v1/:facility_id/tenants/:id
Update a tenant

PUT /v1/:facility_id/tenants/:id
Update a tenant

Params

Param name Description
tenant
optional

Validations:

  • Must be a Hash
tenant[first_name]
optional

Validations:

  • Must be a String
tenant[account_number]
optional

Validations:

  • Must be a String
tenant[middle_initial]
optional

Validations:

  • Must be a String
tenant[last_name]
optional

Validations:

  • Must be a String
tenant[drivers_license_number]
optional

Validations:

  • Must be a String
tenant[drivers_license_state]
optional

Validations:

  • Must be a String
tenant[vehicle_license_plate_number]
optional

Validations:

  • Must be a String
tenant[vehicle_license_state]
optional

Validations:

  • Must be a String
tenant[vehicle_description]
optional

Validations:

  • Must be a String
tenant[email]
optional

Validations:

  • Must be a String
tenant[username]
optional

Validations:

  • Must be a String
tenant[password]
optional

Validations:

  • Must be a String
tenant[tax_exempt]
optional

Is the tenant tax exempt?

Validations:

  • Must be one of: true, false, 1, 0.
tenant[is_military]
optional

Is the tenant military?

Validations:

  • Must be one of: true, false, 1, 0.
tenant[is_business]
optional

Is the tenant a business?

Validations:

  • Must be one of: true, false, 1, 0.
tenant[business_name]
optional

Validations:

  • Must be a String
tenant[title]
optional

Validations:

  • Must be a String
tenant[decline_alternate_contact]
optional

Whether or not the tenant declined to provide alternate contact information

Validations:

  • Must be one of: true, false, 1, 0.
tenant[military_information]
optional

A collection of military information (if is_military is true).

Validations:

  • Must be a Hash
tenant[military_information][retired_military]
optional

Is the tenant retired military?

Validations:

  • Must be one of: true, false, 1, 0.
tenant[military_information][no_agent_given]
optional

Is agent information provided?

Validations:

  • Must be one of: true, false, 1, 0.
tenant[military_information][date_entered_service]
optional

Date entered service, Format: YYYY-MM-DD

Validations:

  • Must be a Date
tenant[military_information][military_id]
optional

Validations:

  • Must be a String
tenant[military_information][end_of_active_service_date]
optional

End date of active service, Format: YYYY-MM-DD

Validations:

  • Must be a Date
tenant[military_information][place_of_birth]
optional

Validations:

  • Must be a String
tenant[military_information][last_4_of_ssn]
optional

Must be a 4 digit number

Validations:

  • Must be a String
tenant[military_information][military_email_address]
optional

Must be a valid email address

Validations:

  • Must be a String
tenant[military_information][military_rank]
optional

Validations:

  • Must be a String
tenant[military_information][current_duty_location]
optional

Validations:

  • Must be a String
tenant[military_information][branch_of_service]
optional

Must be Air Force, Army, Coast Guard, Marines, Navy, National Guard, or Other

Validations:

  • Must be a String
tenant[military_information][military_unit]
optional

Validations:

  • Must be a String
tenant[military_information][squadron]
optional

Validations:

  • Must be a String
tenant[military_information][division]
optional

Validations:

  • Must be a String
tenant[military_information][type_of_service]
optional

Must be Active Component, Reserve Component, or National Guard

Validations:

  • Must be a String
tenant[military_information][agent_first_name]
optional

Validations:

  • Must be a String
tenant[military_information][agent_last_name]
optional

Validations:

  • Must be a String
tenant[military_information][agent_email_address]
optional

Must be a valid email address

Validations:

  • Must be a String
tenant[military_information][agent_phone_number]
optional

Must be a valid phone number

Validations:

  • Must be a String
tenant[military_information][agent_address]
optional

Validations:

  • Must be a String
tenant[military_information][agent_city]
optional

Validations:

  • Must be a String
tenant[military_information][agent_state]
optional

Must be a valid state abbreviation

Validations:

  • Must be a String
tenant[military_information][agent_postal_code]
optional

Must be a valid US postal code

Validations:

  • Must be a String
tenant[military_information][officer_first_name]
optional

Validations:

  • Must be a String
tenant[military_information][officer_last_name]
optional

Validations:

  • Must be a String
tenant[military_information][officer_phone_number]
optional

Must be a valid phone number

Validations:

  • Must be a String
tenant[password_recovery_questions_attributes]
optional

Password recovery questions

Validations:

  • Must be an Array of nested elements
tenant[password_recovery_questions_attributes][question]
required

Validations:

  • Must be a String
tenant[password_recovery_questions_attributes][answer]
required

Validations:

  • Must be a String
tenant[phone_numbers_attributes]
required

A collection of phone numbers.

Validations:

  • Must be an Array of nested elements
tenant[phone_numbers_attributes][number]
optional

Phone number

Validations:

  • Must be a String
tenant[phone_numbers_attributes][extension]
required

Phone number extension

Validations:

  • Must be a String
tenant[phone_numbers_attributes][label]
optional

A label for what the phone number is, such as Home, Work, Mobile, etc.

Validations:

  • Must be a String
tenant[phone_numbers_attributes][primary]
optional

Flag that indicates if this is the primary phone number of the tenant

Validations:

  • Must be a String
tenant[phone_numbers_attributes][sms_opt_in]
optional

Opt the tenant in to SMS (if applicable). Requires a "Mobile" label for SMS to work correctly.

Validations:

  • Must be one of: true, false, 1, 0.
tenant[mailing_address_attributes]
required

A collection of addresses.

Validations:

  • Must be a Hash
tenant[mailing_address_attributes][address1]
required

Validations:

  • Must be a String
tenant[mailing_address_attributes][address2]
optional

Validations:

  • Must be a String
tenant[mailing_address_attributes][city]
required

Validations:

  • Must be a String
tenant[mailing_address_attributes][state]
required

Validations:

  • Must be a String
tenant[mailing_address_attributes][postal]
required

Validations:

  • Must be a String
tenant[contacts_attributes]
optional

A collection of contacts.

Validations:

  • Must be an Array of nested elements
tenant[contacts_attributes][id]
optional

Contact id required to update a contact.

Validations:

  • Must be a String
tenant[contacts_attributes][first_name]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][middle_initial]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][last_name]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][email]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][description]
required

Contact description

Validations:

  • Must be a String
tenant[contacts_attributes][primary]
optional

Flag that indicates if this is the primary contact of the tenant

Validations:

  • Must be a String
tenant[contacts_attributes][phone_numbers_attributes]
optional

A collection of phone numbers.

Validations:

  • Must be an Array of nested elements
tenant[contacts_attributes][phone_numbers_attributes][number]
optional

Phone number

Validations:

  • Must be a String
tenant[contacts_attributes][phone_numbers_attributes][extension]
optional

Phone number extension

Validations:

  • Must be a String
tenant[contacts_attributes][phone_numbers_attributes][label]
optional

A label for what the phone number is, such as Home, Work, Mobile, etc.

Validations:

  • Must be a String
tenant[contacts_attributes][phone_numbers_attributes][primary]
optional

Flag that specifies if this is the primary phone number of the contact

Validations:

  • Must be a String
tenant[contacts_attributes][address_attributes]
optional

A collection of addresses.

Validations:

  • Must be a Hash
tenant[contacts_attributes][address_attributes][address1]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][address_attributes][address2]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][address_attributes][city]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][address_attributes][state]
optional

Validations:

  • Must be a String
tenant[contacts_attributes][address_attributes][postal]
optional

Validations:

  • Must be a String

Examples

PUT /v1/7864e018-d91f-4487-91fd-370bfa73477d/tenants/b67ffe7f-cc9f-4b40-ae6b-bc8f61acf2ad
{
  "tenant": {
    "first_name": "Kelvin",
    "last_name": "Benjamin",
    "phone_numbers_attributes": [
      {
        "number": "5656663476",
        "label": "Mobile",
        "sms_opt_in": true
      }
    ],
    "mailing_address_attributes": {
      "address1": "Ikea St",
      "city": "Ikealand",
      "state": "KS"
    }
  }
}
200
{
  "tenant": {
    "id": "b67ffe7f-cc9f-4b40-ae6b-bc8f61acf2ad",
    "account_number": 1000000,
    "first_name": "Kelvin",
    "last_name": "Benjamin",
    "middle_initial": null,
    "email": "[email protected]",
    "tax_exempt": false,
    "is_military": false,
    "is_business": false,
    "business_name": null,
    "last_sign_in_at": null,
    "title": null,
    "delinquent": false,
    "current_ledger_ids": [
      "76e6b8f4-6c07-433f-be54-02763b2f3832"
    ],
    "preferences": {
      "email_invoices": true,
      "print_invoices": false,
      "charge_invoice_fee": true,
      "receive_legal_notices_by_email": null,
      "delinquency_exempt": false,
      "delinquency_docs_by_email": false,
      "delinquency_docs_by_mail": false,
      "receive_sms_for_gate_activity": false,
      "opt_in_to_marketing_emails": false,
      "opt_in_to_marketing_sms": false,
      "opt_in_to_transactional_sms": false,
      "exclude_from_insurance_auto_enroll": false,
      "exclude_from_insurance_auto_enroll_reason": null,
      "exclude_from_insurance_auto_enroll_created_by": null,
      "exclude_from_insurance_auto_enroll_on": null
    },
    "military_information": null,
    "username": "username_74",
    "drivers_license_number": null,
    "drivers_license_state": null,
    "vehicle_license_plate_number": null,
    "vehicle_license_state": null,
    "vehicle_description": null,
    "has_tenant_portal_account": false,
    "created_at": "2023-09-15T04:37:35.003-10:00",
    "gate_24_hour_access": false,
    "active": true,
    "tenant_account_kind_name": "Standard",
    "blocked_payments": false,
    "date_of_birth": null,
    "phone_numbers": [
      {
        "id": "d48e417d-21e9-4588-9348-34e11660e0c8",
        "primary": true,
        "source": null,
        "number": "+13202130066",
        "formatted_number": "(320) 213-0066 x 2433",
        "extension": "2433",
        "label": "Pager",
        "unformatted_number": "3202130066",
        "sms_opt_in": false
      },
      {
        "id": "5b72e42f-8588-42e3-ad0b-643c8bbb0a56",
        "primary": false,
        "source": null,
        "number": "+13602676190",
        "formatted_number": "(360) 267-6190 x 0409",
        "extension": "0409",
        "label": "Mobile",
        "unformatted_number": "3602676190",
        "sms_opt_in": false
      },
      {
        "id": "cc69fd2c-a7b8-451a-be90-7d0a7805a111",
        "primary": false,
        "source": null,
        "number": "+18604755597",
        "formatted_number": "(860) 475-5597",
        "extension": null,
        "label": "Pager",
        "unformatted_number": "8604755597",
        "sms_opt_in": false
      },
      {
        "id": "388d0cd3-0166-4a41-b725-0010571fecda",
        "primary": false,
        "source": null,
        "number": "+15656663476",
        "formatted_number": "(565) 666-3476",
        "extension": null,
        "label": "Mobile",
        "unformatted_number": "5656663476",
        "sms_opt_in": true
      }
    ],
    "mailing_address": {
      "id": "5197cc1a-bded-492d-858e-d62cf09b198d",
      "address1": "Ikea St",
      "address2": null,
      "city": "Ikealand",
      "state": "KS",
      "postal": "89980",
      "country": "US",
      "full_address": "Ikea St, Ikealand, KS 89980",
      "latitude": 39.114844,
      "longitude": -94.630169,
      "time_zone_id": "America/Chicago",
      "time_zone_offset": "-05:00",
      "invalid_data": false,
      "label": "Home"
    },
    "addresses": [
      {
        "id": "5197cc1a-bded-492d-858e-d62cf09b198d",
        "address1": "Ikea St",
        "address2": null,
        "city": "Ikealand",
        "state": "KS",
        "postal": "89980",
        "country": "US",
        "full_address": "Ikea St, Ikealand, KS 89980",
        "latitude": 39.114844,
        "longitude": -94.630169,
        "time_zone_id": "America/Chicago",
        "time_zone_offset": "-05:00",
        "invalid_data": false,
        "label": "Home"
      },
      {
        "id": "5197cc1a-bded-492d-858e-d62cf09b198d",
        "address1": "Ikea St",
        "address2": null,
        "city": "Ikealand",
        "state": "KS",
        "postal": "89980",
        "country": "US",
        "full_address": "Ikea St, Ikealand, KS 89980",
        "latitude": 39.114844,
        "longitude": -94.630169,
        "time_zone_id": "America/Chicago",
        "time_zone_offset": "-05:00",
        "invalid_data": false,
        "label": "Home"
      }
    ],
    "facility_id": "7864e018-d91f-4487-91fd-370bfa73477d",
    "previous_ledger_ids": [],
    "lead_ids": [],
    "closed_lead_ids": [],
    "contact_ids": [
      "cbbb886b-3099-4075-abaa-d3cb7a88fd0d"
    ],
    "support_case_ids": [],
    "event_ids": [
      "4e1c5f33-83ab-4853-983f-6f445d91b4a3",
      "9e163046-2137-4e5e-b7a0-1df8cea29c2a"
    ],
    "password_recovery_question_ids": [
      "e3d55c85-75a7-4aee-8e64-de24f7cf083d",
      "a2b8a7d3-37a0-4a39-a946-645e44295433"
    ]
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "PUT",
    "request_id": null,
    "parameters": {
      "tenant": {
        "first_name": "Kelvin",
        "last_name": "Benjamin",
        "phone_numbers_attributes": [
          {
            "number": "5656663476",
            "label": "Mobile",
            "sms_opt_in": true
          }
        ],
        "mailing_address_attributes": {
          "address1": "Ikea St",
          "city": "Ikealand",
          "state": "KS"
        }
      },
      "facility_id": "7864e018-d91f-4487-91fd-370bfa73477d",
      "id": "b67ffe7f-cc9f-4b40-ae6b-bc8f61acf2ad"
    }
  }
}