Update amenity

PATCH/api/v2/amenities/{amenity}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

is_enabled?boolean

is_property_marketable?boolean

code?string|null

description?string|null

type?|

Value in

"community_amenity"
"unit_amenity"
null

mits_amenity_type?|

The MITS 5.0 amenity type ILS feeds carry (AmenityType in an Apartments.com feed). Null when the amenity has no MITS equivalent.

Value in

"24 Hour Access"
"Basketball Court"
"Bicycle Storage"
"Breakfast/Coffee Concierge"
"Business Center"
"Cabana"
"Car Charging Station"
"Car Wash Area"
"Clubhouse"
"Community-Wide WiFi"
"Composting"
"Concierge"
"Controlled Access"
"Corporate Suites"
"Courtyard"
"Day Care"
"Disposal Chutes"
"Dock"
"Doorman"
"Dry Cleaning Service"
"Elevator"
"Fenced Lot"
"Fitness Center"
"Furnished Units Available"
"Gameroom"
"Gas Range"
"Gated"
"Golf Course"
"Grill"
"Grocery Service"
"Guest Apartment"
"Health Club Discount"
"Hearing Impaired Accessible"
"House Sitter Services"
"Individual Locking Bedrooms"
"Lake Access"
"Laundry Facilities"
"Laundry Service"
"Lounge"
"Maid Service"
"Maintenance on site"
"Meal Service"
"Media Center/Movie Theatre"
"Multi Use Room"
"On-Site ATM"
"On-Site Retail"
"Online Services"
"Package Service"
"Pet Care"
"Pet Play Area"
"Pet Washing Station"
"Picnic Area"
"Planned Social Activities"
"Playground"
"Pond"
"Pool"
"Private Bathroom"
"Property Manager on Site"
"Public Transportation"
"Putting Greens"
"Racquetball Court"
"Recycling"
"Renters Insurance Program"
"Roof Terrace"
"Roommate Matching"
"Sauna"
"Shuttle To Campus"
"Shuttle to Train"
"Spa"
"Storage Space"
"Study Lounge"
"Sundeck"
"Tanning Salon"
"Tennis Court"
"Trash Pickup - Curbside"
"Trash Pickup - Door to Door"
"Video Patrol"
"Vintage Building"
"Vision Impaired Accessible"
"Volleyball Court"
"Walk To Campus"
"Walking/Biking Trails"
"Waterfront"
"Wi-Fi"
"Zen Garden"
"Individual Leases Available"
"Key Fob Entry"
"Conference Rooms"
"Hot Tub"
"Walk-Up"
"Dog Park"
"Air Conditioning"
"Attic"
"Balcony"
"Basement"
"Bay Window"
"Breakfast Nook"
"Built-In Bookshelves"
"Cable Ready"
"Carpet"
"Ceiling Fans"
"Coffee System"
"Crown Molding"
"Deck"
"Den"
"Dining Room"
"Dishwasher"
"Disposal"
"Double Pane Windows"
"Double Vanities"
"Eat-in Kitchen"
"Family Room"
"Fireplace"
"Framed Mirrors"
"Freezer"
"Furnished"
"Garden"
"Granite Countertops"
"Greenhouse"
"Handrails"
"Hardwood Floors"
"Heating"
"High Ceilings"
"High Speed Internet Access"
"Ice Maker"
"Instant Hot Water"
"Intercom"
"Island Kitchen"
"Kitchen"
"Large Bedrooms"
"Lawn"
"Linen Closet"
"Loft Layout"
"Microwave"
"Mother-in-law Unit"
"Mud Room"
"Office"
"Oven"
"Pantry"
"Patio"
"Porch"
"Range"
"Recreation Room"
"Refrigerator"
"Satellite TV"
"Security System"
"Skylights"
"Smoke Free"
"Sprinkler System"
"Stainless Steel Appliances"
"Sunroom"
"Surround Sound"
"Tile Floors"
"Trash Compactor"
"Tub/Shower"
"Vacuum System"
"Vaulted Ceiling"
"Views"
"Vinyl Flooring"
"Walk-In Closets"
"Warming Drawer"
"Washer/Dryer"
"Washer/Dryer Hookup"
"Wet Bar"
"Wheelchair Accessible (Rooms)"
"Window Coverings"
"Workshop"
"Yard"
"Floor to Ceiling Windows"
"Quartz Countertops"
"Other"
null

tags?array<unknown>|null

reference_id?string|null

property_ids?array<>

The complete set of properties this amenity is linked to. Replaces the current set; [] clears it; omit to leave it unchanged.

unit_ids?array<>

The complete set of units this amenity is linked to. Replaces the current set; [] clears it; omit to leave it unchanged.

Itemsitems <= 2000

floor_plan_ids?array<>

The complete set of floor plans this amenity is linked to. Replaces the current set; [] clears it; omit to leave it unchanged.

Itemsitems <= 500

property_id?string

Shorthand for a one-element property_ids; ignored when property_ids is sent.

Formatuuid

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v2/amenities/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z",    "name": "string",    "is_enabled": true,    "is_property_marketable": true,    "code": "string",    "description": "string",    "type": "community_amenity",    "mits_amenity_type": "24 Hour Access",    "tags": [      null    ],    "reference_id": "string",    "property_ids": [      "03729b6d-baa6-45e3-8afa-c6e3d7ae6182"    ],    "images": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "url": "string",        "thumb_url": "string",        "full_url": "string",        "caption": "string",        "alt_text": "string",        "tags": [          "string"        ],        "reference_url": "string",        "reference_id": "string",        "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",        "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"      }    ],    "videos": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "type": "string",        "provider": "string",        "url": "string",        "title": "string",        "settings": {},        "tags": [          "string"        ],        "sort_order": 0,        "image": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "url": "string",          "thumb_url": "string",          "full_url": "string",          "caption": "string",          "alt_text": "string",          "tags": [            "string"          ],          "reference_url": "string",          "reference_id": "string",          "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",          "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"        }      }    ],    "virtual_tours": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "type": "string",        "provider": "string",        "url": "string",        "title": "string",        "settings": {},        "tags": [          "string"        ],        "sort_order": 0,        "image": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "url": "string",          "thumb_url": "string",          "full_url": "string",          "caption": "string",          "alt_text": "string",          "tags": [            "string"          ],          "reference_url": "string",          "reference_id": "string",          "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",          "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"        }      }    ],    "unit_ids": [      "9d1db2ab-2a86-4942-acb8-6f789d59bd45"    ],    "floor_plan_ids": [      "3c9ff231-e3de-4724-ac4a-8bf606e6a487"    ]  }}

Update amenity

Authorization

Path Parameters

Query Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Update amenity

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/json

403application/json

404application/json

422application/json

Authorization

Path Parameters

Query Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`