Sign in

v1

latestSwagger 2.02026-08-04283399898.4 KB
users

Update a user

patch/users/{id}

Path parameters

idinteger required

Request body

affiliate_descriptionstring
anonymized_byinteger
anonymized_onstring
avatar_urlstring
birthdatestring
coaching_completedboolean
coaching_completed_on_datestring
coaching_dismissed_countinteger
disable_phoneboolean
emailstring
exclude_locationsstring[]

DBStringSlice is a []string with database conversion methods

{"stackTrail":"components:schemas:DBInterfaceMap","oasType":"schema","type":"unknown","description":"DBInterfaceMap is a map[string]interface{} with database conversion methods","extensionFields":{"x-go-package":"github.com/outdoorsy/api/utils"}}
first_namestring
genderstring
google_place_idstring
guest_smart_match_opt_outboolean
last_namestring
licenseLicense

License holds driver's license information for a user

listing_coach_dismiss_flagboolean
logo_urlstring
mast_image_urlstring
nationalitystring
od_stays_opt_inboolean
phonestring
sd_waiver_enabledboolean nullable
sms_exclude_locationsinteger[]

DBIntSlice is a []int with database conversion methods

titlestring
{"stackTrail":"components:schemas:DBInterfaceMap","oasType":"schema","type":"unknown","description":"DBInterfaceMap is a map[string]interface{} with database conversion methods","extensionFields":{"x-go-package":"github.com/outdoorsy/api/utils"}}
user_typestring

Response

HTTP status code 200 and user model

accept_percentnumber double
accepted_tos_versioninteger
account_idstring nullable
active_quotes_countinteger
active_reservations_countinteger

Holds the count of active reservations and quotes for DOU

addon_fee_percentagenumber double
adminboolean
admin_levelinteger
api_keystring
approved_driversboolean
archivedboolean nullable
auto_ownerboolean
bank_countrystring
bannedboolean

admin only

campground_ownerboolean
campground_userboolean
can_accept_paymentsboolean
cash_creditsinteger
cc_fee_percentagenumber double
commercial_insuranceboolean
completed_bookingsinteger
confirmedboolean
createdstring
creditsinteger
csm_agent_idinteger

User ID of the CSM agent assigned to the corresponding owner/dealer

deal_idstring

Deal ID used to store Hubspot deals

dealerboolean

dealer/employee support

deposits_disabledboolean
display_w9_reminderboolean
driver_checks_enabledboolean
employeeboolean
esign_enabledboolean
fleet_api_keystring
force_reconnect_bankboolean
fraud_review_completeboolean
fraudulentboolean
group_on_mapboolean
guestboolean
has_connected_gatewayboolean

Indicates to the FE that this user has a connected gateway and the Spreedly CC form should be used when adding renter CCs

has_gps_deviceboolean
has_notes_to_renters_migratedboolean
has_setup_intent_enabledboolean
hiddenboolean
host_type_by_rental_categorystring
host_type_by_rental_countstring
idinteger

internal - server generated and not mutable by PATCH

impersonatedboolean
import_idstring
inactive_byinteger
inactive_onstring
is_admin_managed_superhostboolean
is_award_winnerboolean
is_csm_agentboolean

Represents if a user is CSM agent

is_military_hostboolean
is_superhostboolean

SuperHost

last_accessed_ipstring nullable
last_activity_atstring
legacy_tracking_device_countinteger
metadataMSI
missing_fieldsstring[]

DBStringSlice is a []string with database conversion methods

num_reservationsinteger
offer_roamlyboolean
offers_deliveryboolean
owned_by_idinteger
ownerboolean
owner_fee_percentagenumber double

admin only

owner_scorenumber double
owner_score_countinteger
partner_app_idinteger nullable
partner_idinteger nullable
pending_emailstring
permissionsDBBoolMap

DBBoolMap is a map[string]boold with database conversion methods

proboolean
reconnect_bankboolean
referral_codestring
referred_by_idinteger
referred_owner_paidboolean
referred_owner_payout_amountinteger
referred_renter_paidboolean
referred_renter_payout_amountinteger
renterboolean
renter_fee_percentagenumber double
require_w9_formboolean
require_w9_to_accept_bookingboolean
roadside_missingstring[]

DBStringSlice is a []string with database conversion methods

roamly_carshare_userboolean
roamly_policy_idstring
roamly_policy_numberstring
roamly_statusstring
rv_ownerboolean

Host Rental Possession

scorenumber double
score_countinteger

Only used by database triggers, not intended for use by anything in the application. They're listed here to make sure the migration system creates the columns.

search_metrics_start_datestring
self_serve_signupboolean nullable
session_idstring
show_gps_deprecation_warningboolean
signup_sourcestring
skip_w9_to_publishboolean
slugstring
stay_ownerboolean
superhost_cancel_ratenumber double
superhost_departed_bookingsinteger
superhost_last_assessmentstring
superhost_last_start_assessmentstring
superhost_response_ratenumber double
superhost_review_ratenumber double
superhost_reviewed_bookingsinteger
time_to_first_actioninteger
tolls_enabledboolean
tollspot_account_numberstring
tollspot_account_statusstring
tos_acceptance_datestring
total_bookingsinteger
undelivered_emails_countinteger

Indicates if there are undelivered emails for the last booking of DOU

use_fees_increaseboolean nullable
use_insurance_bundlesboolean
viewed_outdoorsy_host_betaboolean
viewed_roamly_adboolean
viewed_smart_match_bannerboolean
viewed_smart_pricing_bannerboolean
viewed_super_host_bannerboolean
w9_completed_atstring
w9_eligibleboolean
w9_tax_form_completedboolean
w9_tin_statusstring
waive_w9_completionboolean
wheelbase_feeinteger nullable