{"RequestUserAlias":"not_set_documentation_only","RequestPath":"\/v1\/documentation\/get_search_index","RequestStatus":"Succeeded","ResponseCode":100,"ResponseMessage":"Request Successful","Payload":{"entries":[{"category":"account","method":"get_incoming_payment_session","summary":"Returns details of the incoming payment session and information on whether it has been completed or is still pending.","url":"\/api-documentation?category=account#ep-account-get_incoming_payment_session"},{"category":"account","method":"get_ledger","summary":"Returns paginated ledger entries for one account owned by the acting API user. Admin tools should access another user's ledger through the dispatcher impersonationUserAlias parameter; this endpoint still validates the ac","url":"\/api-documentation?category=account#ep-account-get_ledger"},{"category":"account","method":"get_list","summary":"Returns all available user accounts including their balances and if applicable credit limits in the smallest possible currency unit","url":"\/api-documentation?category=account#ep-account-get_list"},{"category":"account","method":"set_start_incoming_payment_session","summary":"Creates an incoming payments session which will be credited to API users main account. The gross amount will be discounted, and the discounted expected payment will be returned","url":"\/api-documentation?category=account#ep-account-set_start_incoming_payment_session"},{"category":"aichat","method":"get","summary":"Gets messages for a user thread","url":"\/api-documentation?category=aichat#ep-aichat-get"},{"category":"aichat","method":"get_status","summary":"Gets messages for a user thread","url":"\/api-documentation?category=aichat#ep-aichat-get_status"},{"category":"aichat","method":"set","summary":"Sends a message to an AI chat","url":"\/api-documentation?category=aichat#ep-aichat-set"},{"category":"aichat","method":"set_clear","summary":"Clear chat history","url":"\/api-documentation?category=aichat#ep-aichat-set_clear"},{"category":"appsv2","method":"get_about_post_candidates","summary":"Finds public community posts that can be selected as an app's About my app post. Eligibility mirrors the profile\/About Me selector.","url":"\/api-documentation?category=appsv2#ep-appsv2-get_about_post_candidates"},{"category":"appsv2","method":"get_checkout_url","summary":"Returns an inline custom-article checkout URL for paid app access.","url":"\/api-documentation?category=appsv2#ep-appsv2-get_checkout_url"},{"category":"appsv2","method":"get_list","summary":"Returns the list of published user-created apps for the appstore. Public-by-design: the appstore is a public browse surface; paid apps only expose storefront metadata here, while app access is enforced by \/modules\/v2\/_ap","url":"\/api-documentation?category=appsv2#ep-appsv2-get_list"},{"category":"appsv2","method":"get_my_apps","summary":"Returns apps owned by the current viewer for the App Store setup UI.","url":"\/api-documentation?category=appsv2#ep-appsv2-get_my_apps"},{"category":"appsv2","method":"set_about_post","summary":"Sets or clears an app's About my app post.","url":"\/api-documentation?category=appsv2#ep-appsv2-set_about_post"},{"category":"appsv2","method":"set_create","summary":"Create a new user-published app row in the v2 appstore.","url":"\/api-documentation?category=appsv2#ep-appsv2-set_create"},{"category":"appsv2","method":"set_update","summary":"Update a user-owned v2 app's storefront setup.","url":"\/api-documentation?category=appsv2#ep-appsv2-set_update"},{"category":"auction","method":"get_bid_status","summary":"Read one checkout attempt belonging to the acting buyer, including pending funding.","url":"\/api-documentation?category=auction#ep-auction-get_bid_status"},{"category":"auction","method":"get_detail","summary":"Public-by-design: public auction information excludes reservation secrets, bidder identities and funding records.","url":"\/api-documentation?category=auction#ep-auction-get_detail"},{"category":"auction","method":"get_my_bids","summary":"","url":"\/api-documentation?category=auction#ep-auction-get_my_bids"},{"category":"auction","method":"set_bid_checkout","summary":"Prepare a funded auction bid. Opening checkout does not reserve inventory or extend the deadline.","url":"\/api-documentation?category=auction#ep-auction-set_bid_checkout"},{"category":"auction","method":"set_cancel","summary":"Cancel a bid-free owned auction, or administratively cancel invalid inventory and return deposits.","url":"\/api-documentation?category=auction#ep-auction-set_cancel"},{"category":"auction","method":"set_save","summary":"Configure an owned listing's sale format before its first funded bid.","url":"\/api-documentation?category=auction#ep-auction-set_save"},{"category":"auth","method":"get_sessions","summary":"Return the authenticated user's active sessions, with the current browser session marked for display on the native v2 Session Manager.","url":"\/api-documentation?category=auth#ep-auth-get_sessions"},{"category":"auth","method":"set_all_sessions_removed","summary":"Remove every active session owned by the authenticated user, including the current browser session. The browser cookie is expired and the response includes signedOut=true.","url":"\/api-documentation?category=auth#ep-auth-set_all_sessions_removed"},{"category":"auth","method":"set_google_oauth_state","summary":"Create signed Google OAuth state, including optional signup-page context. Public-by-design: anonymous users must be able to begin Google authentication.","url":"\/api-documentation?category=auth#ep-auth-set_google_oauth_state"},{"category":"auth","method":"set_other_sessions_removed","summary":"Remove every active session except the current browser session. The viewer remains signed in on this device and receives a refreshed list.","url":"\/api-documentation?category=auth#ep-auth-set_other_sessions_removed"},{"category":"auth","method":"set_send_login_code","summary":"Send an email login code using the existing authentication flow. A new account retains optional signup-page context independently from its post-login return destination. Public-by-design: anonymous users must be able to ","url":"\/api-documentation?category=auth#ep-auth-set_send_login_code"},{"category":"auth","method":"set_session_removed","summary":"Remove one active session owned by the authenticated user. If that session is the current browser session, the browser cookie is expired and the response includes signedOut=true.","url":"\/api-documentation?category=auth#ep-auth-set_session_removed"},{"category":"beta_program","method":"get_invite_commission_preview","summary":"Return the legacy invite-friends commission preview as structured data, using the authenticated user's current commission permissions.","url":"\/api-documentation?category=beta_program#ep-beta_program-get_invite_commission_preview"},{"category":"beta_program","method":"get_invites","summary":"Return the authenticated user's beta invite summary, including remaining credits, return credits from redeemed codes, active unused codes, and redeemed codes with claimant details.","url":"\/api-documentation?category=beta_program#ep-beta_program-get_invites"},{"category":"beta_program","method":"set_create_contextual_invite_link","summary":"Create a reusable invite link with optional onboarding context. While the beta invite gate is enabled, the link carries a beta code; when the gate is later disabled, the same link shape still carries referral\/context.","url":"\/api-documentation?category=beta_program#ep-beta_program-set_create_contextual_invite_link"},{"category":"beta_program","method":"set_create_invite_code","summary":"Create one unused beta invite code if the authenticated user has invite credits remaining. Creating an unused code consumes one visible credit.","url":"\/api-documentation?category=beta_program#ep-beta_program-set_create_invite_code"},{"category":"beta_program","method":"set_revoke_invite_code","summary":"Revoke an unused beta invite code owned by the authenticated user. Revoking an unused code returns one visible invite credit.","url":"\/api-documentation?category=beta_program#ep-beta_program-set_revoke_invite_code"},{"category":"bid","method":"get_feedback_suggestions","summary":"Get up to five of the acting concierge's previously submitted custom feedback responses.","url":"\/api-documentation?category=bid#ep-bid-get_feedback_suggestions"},{"category":"bid","method":"get_list","summary":"Returns available bids without a publication delay, subject to access restrictions.","url":"\/api-documentation?category=bid#ep-bid-get_list"},{"category":"bid","method":"get_pickup_requirements","summary":"Returns the seller pickup state and confirmation data for one bid.","url":"\/api-documentation?category=bid#ep-bid-get_pickup_requirements"},{"category":"bid","method":"get_required_feedback","summary":"Returns active notified bids the acting seller is eligible to pick up at their currently followed locations. An empty array clears prior requests.","url":"\/api-documentation?category=bid#ep-bid-get_required_feedback"},{"category":"bid","method":"get_submission","summary":"Returns the acting submitter's private bid confirmation or immutable completed receipt.","url":"\/api-documentation?category=bid#ep-bid-get_submission"},{"category":"bid","method":"set","summary":"Places a bid Please note that users are required to hold the API Developer medal to access automated buying. A minimum balance of $50 per automatically purchased listings that have not passed by at least 72 hours is requ","url":"\/api-documentation?category=bid#ep-bid-set"},{"category":"bid","method":"set_cancel","summary":"Cancels an active bid","url":"\/api-documentation?category=bid#ep-bid-set_cancel"},{"category":"bid","method":"set_drop","summary":"Release a bid currently held by the acting seller.","url":"\/api-documentation?category=bid#ep-bid-set_drop"},{"category":"bid","method":"set_feedback","summary":"Send seller feedback for a bid, such as no connection or bid too low.","url":"\/api-documentation?category=bid#ep-bid-set_feedback"},{"category":"bid","method":"set_note","summary":"Save the acting seller's private note for a bid.","url":"\/api-documentation?category=bid#ep-bid-set_note"},{"category":"bid","method":"set_pickup","summary":"Pick up and hold a bid for the acting seller, or return auctionRequired and auctionURL when paid pickup is required. An auction redirect is not a hold. Use \/v1\/bidauction\/get_state and \/v1\/bidauction\/set_checkout to comp","url":"\/api-documentation?category=bid#ep-bid-set_pickup"},{"category":"bid","method":"set_reservation_contact","summary":"Saves the bidder-specified reservation contact details for an active bid.","url":"\/api-documentation?category=bid#ep-bid-set_reservation_contact"},{"category":"bid","method":"set_shortlist","summary":"Shortlist or un-shortlist a bid for the acting seller.","url":"\/api-documentation?category=bid#ep-bid-set_shortlist"},{"category":"bid","method":"set_text_feedback","summary":"Post custom feedback to the bid discussion and resolve the acting concierge's pending feedback.","url":"\/api-documentation?category=bid#ep-bid-set_text_feedback"},{"category":"bidauction","method":"get_list","summary":"Visible paid live auctions, with the acting seller's accepted participation first, then earliest closing. Includes finalizing rounds. Returns 25 cards per page, serverTime, page and total. No competitor identities.","url":"\/api-documentation?category=bidauction#ep-bidauction-get_list"},{"category":"bidauction","method":"get_state","summary":"Auction price, fixed deadline and the acting seller's own offers only. Cash amounts are USD cents.","url":"\/api-documentation?category=bidauction#ep-bidauction-get_state"},{"category":"bidauction","method":"set_checkout","summary":"Creates a seller-bound checkout for the full next cash offer. This does not reserve a bid or the leading position. Normal fulfillment fees are additional. Outbid or unusable card payments return to AT balance.","url":"\/api-documentation?category=bidauction#ep-bidauction-set_checkout"},{"category":"bidpool","method":"get_hold_access","summary":"Explain the acting seller's hold access for a visible, active bid. Does not reserve or mutate the bid. Returns title, message, missingHoldPermissions, permissionGroups (permissionName, label, medals with id\/name\/descript","url":"\/api-documentation?category=bidpool#ep-bidpool-get_hold_access"},{"category":"bidpool","method":"get_mine","summary":"The acting seller's responses on active bids, including pending responses, reopened rounds needing reconfirmation and awarded rounds they responded to. postURL links to the bid's post when available. ownSelected is true\/","url":"\/api-documentation?category=bidpool#ep-bidpool-get_mine"},{"category":"bidpool","method":"get_selection_explanation","summary":"Explain the most recent response-pool selection to any signed-in user, including buyers and nonparticipants. Returns localized summary\/rules and, only after selection, candidates with public sellerAlias, selected\/withdra","url":"\/api-documentation?category=bidpool#ep-bidpool-get_selection_explanation"},{"category":"bidpool","method":"get_state","summary":"Response window, opening-hours-adjusted fillOptions with exact deadlines, timingBaseAt, timingVersion, openingHours status\/timezone, and only the acting seller's response. Times are Unix seconds. scoringVersion describes","url":"\/api-documentation?category=bidpool#ep-bidpool-get_state"},{"category":"bidpool","method":"set_response","summary":"Submit or edit a private response, or immediately pick up when the pool is in immediate mode. Use the preview from get_state. Durations start at round close (or preview time for immediate pickup), shifted to the next ven","url":"\/api-documentation?category=bidpool#ep-bidpool-set_response"},{"category":"bidpool","method":"set_withdraw","summary":"Withdraw only the acting seller's response before the round closes. Does not release a fulfillment hold.","url":"\/api-documentation?category=bidpool#ep-bidpool-set_withdraw"},{"category":"bookmarks","method":"get_list","summary":"Returns the authenticated user's active bookmarks, ordered by their chosen sort (drag-reorderable on the v2 Bookmarks page). Empty array for users with no bookmarks; ErrorInvalidUser for anonymous callers.","url":"\/api-documentation?category=bookmarks#ep-bookmarks-get_list"},{"category":"bookmarks","method":"set_add","summary":"Add (or refresh) a bookmark for the authenticated user. Idempotent on URL: if the user already has a live bookmark for the supplied url, the existing row is returned (with title \/ description updated to the new values) i","url":"\/api-documentation?category=bookmarks#ep-bookmarks-set_add"},{"category":"bookmarks","method":"set_remove","summary":"Remove a bookmark owned by the authenticated user. This is a hard delete. Removing a bookmark that doesn't exist or isn't owned by this user returns Error rather than silently succeeding, so client UI can distinguish \"de","url":"\/api-documentation?category=bookmarks#ep-bookmarks-set_remove"},{"category":"bookmarks","method":"set_reorder","summary":"Replace the user's bookmark sort order with the supplied id list. IDs not currently owned by the user (or already deleted) are silently skipped; any owned bookmarks not present in the list keep their relative order, appe","url":"\/api-documentation?category=bookmarks#ep-bookmarks-set_reorder"},{"category":"checkout","method":"get_context","summary":"Public-by-design: same-origin guest payment preparation uses a session-bound anti-forgery token.","url":"\/api-documentation?category=checkout#ep-checkout-get_context"},{"category":"checkout","method":"get_status","summary":"Public-by-design: only the originating browser or verified intended buyer can read this attempt.","url":"\/api-documentation?category=checkout#ep-checkout-get_status"},{"category":"checkout","method":"set_cancel","summary":"Public-by-design: cancellation requires the originating browser's token and attempt ownership.","url":"\/api-documentation?category=checkout#ep-checkout-set_cancel"},{"category":"checkout","method":"set_prepare","summary":"Public-by-design: prepares a session-owned manual-capture payment; never purchases or creates a bid.","url":"\/api-documentation?category=checkout#ep-checkout-set_prepare"},{"category":"community","method":"get_board_about_post_candidates","summary":"Finds board-local top-level posts that can be selected as the board profile About post.","url":"\/api-documentation?category=community#ep-community-get_board_about_post_candidates"},{"category":"community","method":"get_board_membership","summary":"Get admission settings, membership, and authorized application\/invitation management data.","url":"\/api-documentation?category=community#ep-community-get_board_membership"},{"category":"community","method":"get_chat_actions","summary":"Returns every currently executable action button registered for a chat. Action buttons originate in message DatabaseTags or reusable chat actions registered when chats and participants are created. This endpoint reads AT","url":"\/api-documentation?category=community#ep-community-get_chat_actions"},{"category":"community","method":"get_chat_add_participant_options","summary":"Returns user alias options that the acting user may add to a chat. Chat hosts only see users who accepted a 1:1 chat with the host. Global community administrators can search all non-deleted users. The write endpoint rep","url":"\/api-documentation?category=community#ep-community-get_chat_add_participant_options"},{"category":"community","method":"get_chat_message_changes","summary":"Independently retrieve revisions; never adds work to normal message pagination.","url":"\/api-documentation?category=community#ep-community-get_chat_message_changes"},{"category":"community","method":"get_chat_message_edit_context","summary":"Load an author's editable message and attachments during the original 15-minute window. Active bid-selection restrictions also apply to edits, including pending request messages; ErrorReason=active_bid_selection.","url":"\/api-documentation?category=community#ep-community-get_chat_message_edit_context"},{"category":"community","method":"get_chat_message_history","summary":"Read safe message revisions with the same membership\/history boundary as the message. Deleted history requires an authorized staff finding or report review context.","url":"\/api-documentation?category=community#ep-community-get_chat_message_history"},{"category":"community","method":"get_chat_messages","summary":"Returns the most recent messages for a chat the calling user has access to. Used by the v2 chat dock to populate a chat window on open and to refresh via a 360s offline-recovery poll that runs in parallel with the future","url":"\/api-documentation?category=community#ep-community-get_chat_messages"},{"category":"community","method":"get_chats","summary":"Returns the chats and chat groups visible to the requesting user. Mirrors what \/modules\/chat\/index.php renders so callers can build their own chat overview. Each chat row includes the last message preview, ACTIVE\/ARCHIVE","url":"\/api-documentation?category=community#ep-community-get_chats"},{"category":"community","method":"get_forum_feed","summary":"Returns one page of posts attached to a single community forum board. Public-by-design: public forum feeds are readable by anonymous viewers; restricted boards are still gated by Community::HasAccess.","url":"\/api-documentation?category=community#ep-community-get_forum_feed"},{"category":"community","method":"get_forum_profile","summary":"Returns public profile metadata for a community forum board. Public-by-design: forum profile metadata is readable by anonymous viewers. Restricted boards return safe access-preview metadata only; feeds stay gated. Pendin","url":"\/api-documentation?category=community#ep-community-get_forum_profile"},{"category":"community","method":"get_livestream_obs_config","summary":"Returns the post owner's reusable OBS connection. Never cache or share the stream key.","url":"\/api-documentation?category=community#ep-community-get_livestream_obs_config"},{"category":"community","method":"get_livestream_status","summary":"Returns viewer-filtered state and a fresh playback grant for a readable post. Public-by-design: guests receive lifecycle state only, with a sign-in requirement and no playback grant.","url":"\/api-documentation?category=community#ep-community-get_livestream_status"},{"category":"community","method":"get_location_about_post_candidates","summary":"Finds top-level public community posts connected to a location that can be selected as the location profile About post.","url":"\/api-documentation?category=community#ep-community-get_location_about_post_candidates"},{"category":"community","method":"get_location_feed","summary":"Returns a batch for automatic scrolling through a public location feed. Public-by-design: public location profile feeds are readable by anonymous viewers; restricted boards are still filtered by Community::GetPostsByBoar","url":"\/api-documentation?category=community#ep-community-get_location_feed"},{"category":"community","method":"get_managed_communities","summary":"Lists the acting user's community leadership roles and pending presidency applications. Each community appears once. An active president or secretary role takes precedence over a pending application. Following alone does","url":"\/api-documentation?category=community#ep-community-get_managed_communities"},{"category":"community","method":"get_newsfeed","summary":"Returns one page of newsfeed posts as structured JSON. The cursor is opaque \u00e2\u20ac\u201d pass back the value returned in the previous response's `nextCursor` field. Anonymous callers can read public feeds; signed-in filters are r","url":"\/api-documentation?category=community#ep-community-get_newsfeed"},{"category":"community","method":"get_newsfeed_comment","summary":"Returns one authorized serialized newsfeed comment after a live comment nudge. Public-by-design: public community boards are readable by anonymous viewers; restricted boards are still gated except for comments in the sel","url":"\/api-documentation?category=community#ep-community-get_newsfeed_comment"},{"category":"community","method":"get_newsfeed_post","summary":"Returns one full newsfeed post with its direct comments and subcomments expanded. The post includes lastEditedAt (the latest revision timestamp, or null), separate from createdAt. Public-by-design: public community board","url":"\/api-documentation?category=community#ep-community-get_newsfeed_post"},{"category":"community","method":"get_newsfeed_post_updates","summary":"Refreshes up to 30 visible posts without loading their expanded comment trees. Author privacy applies across discussions while that author has any open buyer response race; identityHiddenUntil is the latest saved closing","url":"\/api-documentation?category=community#ep-community-get_newsfeed_post_updates"},{"category":"community","method":"get_newsfeed_replies","summary":"Returns the first N replies for a post (direct children only, oldest-first). Used by the inline-replies expansion. The reply tree for nested comments-of-comments is loaded lazily by calling this endpoint again with the c","url":"\/api-documentation?category=community#ep-community-get_newsfeed_replies"},{"category":"community","method":"get_newsfeed_reply_example","summary":"Returns short AI-generated example replies for the v2 post detail reply composer. The examples are display-only typewriter prompts. They are never submitted automatically and are cached by post content, viewer role, and ","url":"\/api-documentation?category=community#ep-community-get_newsfeed_reply_example"},{"category":"community","method":"get_post_action_permissions","summary":"Returns call-time action permissions for one newsfeed post. This intentionally checks only the selected post, not every feed card during get_newsfeed serialization.","url":"\/api-documentation?category=community#ep-community-get_post_action_permissions"},{"category":"community","method":"get_post_actions","summary":"Returns visible action buttons for one community post. Public-by-design: this returns only action metadata for a post the viewer can already read; action classes own their own visibility and may omit themselves for anony","url":"\/api-documentation?category=community#ep-community-get_post_actions"},{"category":"community","method":"get_post_edit_context","summary":"Returns the author's editable post or an archived version prepared for restoration.","url":"\/api-documentation?category=community#ep-community-get_post_edit_context"},{"category":"community","method":"get_post_edit_options","summary":"Lists eligible owned attachments or compatible destinations for the post editor.","url":"\/api-documentation?category=community#ep-community-get_post_edit_options"},{"category":"community","method":"get_post_forum_move_options","summary":"Returns same-intent forum choices for moving a top-level community post. Authors can move their own posts into same-intent forums they can write to. Global community forum-move admins can move any top-level post while th","url":"\/api-documentation?category=community#ep-community-get_post_forum_move_options"},{"category":"community","method":"get_post_media","summary":"Current post gallery with live label membership. Visibility is rechecked on every page. Public-by-design: guests may read media on posts whose board and release rules allow them.","url":"\/api-documentation?category=community#ep-community-get_post_media"},{"category":"community","method":"get_post_overlay","summary":"Returns the active site-wide overlay eligible for the current viewer. Public-by-design: guests receive only an active All overlay whose post is publicly readable.","url":"\/api-documentation?category=community#ep-community-get_post_overlay"},{"category":"community","method":"get_post_presence","summary":"Returns signed-in users who have viewed a thread, plus live socket presence for that thread. Public-by-design: public community boards expose thread viewer identity to readers of that thread; restricted boards remain gat","url":"\/api-documentation?category=community#ep-community-get_post_presence"},{"category":"community","method":"get_post_reposts","summary":"Returns people who reposted a visible community post. Public-by-design: the v2 newsfeed exposes the aggregate repost count on public post cards. This endpoint only returns repost wrapper posts the current viewer can read","url":"\/api-documentation?category=community#ep-community-get_post_reposts"},{"category":"community","method":"get_post_version","summary":"Reads one archived snapshot, filtering deleted or inaccessible media on every request. Public-by-design: follows current post, ancestor and attachment visibility.","url":"\/api-documentation?category=community#ep-community-get_post_version"},{"category":"community","method":"get_post_versions","summary":"Lists archived versions without adding history reads to the normal feed. Public-by-design: requires current post access and access to each archived destination.","url":"\/api-documentation?category=community#ep-community-get_post_versions"},{"category":"community","method":"get_reaction_options","summary":"Returns the emoji reaction allowlist used by posts and chat messages. Public-by-design: this exposes only static UI configuration and no user, post, chat, or marketplace data.","url":"\/api-documentation?category=community#ep-community-get_reaction_options"},{"category":"community","method":"get_reactions","summary":"Returns emoji reaction totals for a post or chat message. Public-by-design for public community posts: this returns only aggregate reaction counts. Restricted boards and chat messages are still gated. Public community po","url":"\/api-documentation?category=community#ep-community-get_reactions"},{"category":"community","method":"get_repost_composer_context","summary":"Returns the context required to open the composer for a rich repost. The source post is serialized through the same newsfeed post serializer in compact embedded mode; the client does not receive a parallel mini post shap","url":"\/api-documentation?category=community#ep-community-get_repost_composer_context"},{"category":"community","method":"get_review_request","summary":"Returns the review composer context assigned to the signed-in reviewer. Completed requests include the existing review URL instead of allowing another rating. Missing, deleted and other users' requests return the same er","url":"\/api-documentation?category=community#ep-community-get_review_request"},{"category":"community","method":"get_shared_plan_join_requests","summary":"Get your request state, or the host's paginated request list. Other users' requests are private to the host.","url":"\/api-documentation?category=community#ep-community-get_shared_plan_join_requests"},{"category":"community","method":"get_socialite_event_applications","summary":"Read private event applications as their host or a current community president\/secretary.","url":"\/api-documentation?category=community#ep-community-get_socialite_event_applications"},{"category":"community","method":"set_add_post_media","summary":"Adds uploaded media to a post owned by the current user. Reusable post-edit media endpoint. About Me uses imageOnly=1 so profile media stays selectable; future post editing can pass imageOnly=0 for all supported ATMedia ","url":"\/api-documentation?category=community#ep-community-set_add_post_media"},{"category":"community","method":"set_apply_for_board_president","summary":"Applies to lead a community board that does not currently have a president.","url":"\/api-documentation?category=community#ep-community-set_apply_for_board_president"},{"category":"community","method":"set_board_about_post","summary":"Sets or clears a community board profile About post and optional image selections from that post's attached media.","url":"\/api-documentation?category=community#ep-community-set_board_about_post"},{"category":"community","method":"set_board_membership_accept","summary":"Accept a community invitation and follow the board atomically.","url":"\/api-documentation?category=community#ep-community-set_board_membership_accept"},{"category":"community","method":"set_board_membership_decision","summary":"Approve, reject, or cancel a pending application.","url":"\/api-documentation?category=community#ep-community-set_board_membership_decision"},{"category":"community","method":"set_board_membership_invite","summary":"Create a single-use, credit-exempt community invitation.","url":"\/api-documentation?category=community#ep-community-set_board_membership_invite"},{"category":"community","method":"set_board_membership_invite_revoke","summary":"Revoke an unused membership invitation.","url":"\/api-documentation?category=community#ep-community-set_board_membership_invite_revoke"},{"category":"community","method":"set_board_membership_remove","summary":"Revoke explicit membership without changing independently earned access or following.","url":"\/api-documentation?category=community#ep-community-set_board_membership_remove"},{"category":"community","method":"set_board_membership_request","summary":"Request admission and open the application chat.","url":"\/api-documentation?category=community#ep-community-set_board_membership_request"},{"category":"community","method":"set_board_membership_settings","summary":"Set board-wide admissions and Read or ReadWrite membership access.","url":"\/api-documentation?category=community#ep-community-set_board_membership_settings"},{"category":"community","method":"set_board_pin","summary":"Pins a followed community for the requesting account's personal navigation. Pins retain pinning order ahead of the selected community sort. Unpinning resets the order; following again starts unpinned. Pinning grants no a","url":"\/api-documentation?category=community#ep-community-set_board_pin"},{"category":"community","method":"set_board_secretary","summary":"Assigns or clears a board secretary and delegated board-scoped capabilities.","url":"\/api-documentation?category=community#ep-community-set_board_secretary"},{"category":"community","method":"set_board_view","summary":"Acknowledge a successful community-page visit for the signed-in viewer. Saves the latest published top-level post ID and server visit time. This clears accumulated new-post badges; opening individual threads does not. Co","url":"\/api-documentation?category=community#ep-community-set_board_view"},{"category":"community","method":"set_chat_action","summary":"Executes a chat action button owned by the calling user. The client sends only the action row ID; the server re-reads the stored payload before calling the ActionButton class so stale or forged client payloads cannot exe","url":"\/api-documentation?category=community#ep-community-set_chat_action"},{"category":"community","method":"set_chat_add_participant","summary":"Adds one user to a chat. Hosts may add only users who accepted a 1:1 chat with that host. Global community administrators may add any non-deleted user by alias. Existing participants return success without resetting thei","url":"\/api-documentation?category=community#ep-community-set_chat_add_participant"},{"category":"community","method":"set_chat_archive","summary":"Archives a chat visible to the calling user. This uses the same global active\/inactive status that powers the legacy and native chat inbox archived views.","url":"\/api-documentation?category=community#ep-community-set_chat_archive"},{"category":"community","method":"set_chat_message","summary":"Sends a message into a chat the calling user has access to. Uses the shared NotificationTags chat-send helper that legacy chat message flows also depend on. On success, returns the just-created message in the same shape ","url":"\/api-documentation?category=community#ep-community-set_chat_message"},{"category":"community","method":"set_chat_message_delete","summary":"Delete one's own message for everyone within 15 minutes. Retain private staff audit history.","url":"\/api-documentation?category=community#ep-community-set_chat_message_delete"},{"category":"community","method":"set_chat_message_edit","summary":"Edit one's own text and attachments within 15 minutes; preserve every version. Does not resend alerts.","url":"\/api-documentation?category=community#ep-community-set_chat_message_edit"},{"category":"community","method":"set_chat_minimized_unread_dismissal","summary":"Saves the caller's minimized unread chat dismissal through the latest server-known unread body for that active chat. The client only supplies the chat id; the body id is resolved server-side so a stale or tampered browse","url":"\/api-documentation?category=community#ep-community-set_chat_minimized_unread_dismissal"},{"category":"community","method":"set_chat_mute","summary":"Mutes or unmutes one chat for the requesting user. This is viewer-private and works for any chat the caller can already access. Muted chats remain readable, but the v2 dock treats them as non-urgent and will not auto-sur","url":"\/api-documentation?category=community#ep-community-set_chat_mute"},{"category":"community","method":"set_chat_name","summary":"Renames a chat. Only the chat host (Creator-ATUser_ID) may rename.","url":"\/api-documentation?category=community#ep-community-set_chat_name"},{"category":"community","method":"set_chat_pin","summary":"Pins or unpins a chat for the requesting user's v2 chat lists. The pin state is viewer-private and only applies to chats the caller can already access. Pinned chats sort above recent unpinned chats.","url":"\/api-documentation?category=community#ep-community-set_chat_pin"},{"category":"community","method":"set_chat_read","summary":"Marks every unread notification belonging to this chat as Read for the caller. Used by the v2 chat dock once the user has been \"actively engaged\" (hover\/scroll\/input focus) with a chat for \u00e2\u2030\u00a52 seconds \u00e2\u20ac\u201d the client-sid","url":"\/api-documentation?category=community#ep-community-set_chat_read"},{"category":"community","method":"set_chat_typing","summary":"Relays ephemeral chat typing presence to other participants. This intentionally does not persist any state. It only validates the caller has access to the chat, then emits websocket nudges with minimal context so authori","url":"\/api-documentation?category=community#ep-community-set_chat_typing"},{"category":"community","method":"set_create_poll_answer_for_question","summary":"Create a new answer option for the Question","url":"\/api-documentation?category=community#ep-community-set_create_poll_answer_for_question"},{"category":"community","method":"set_create_poll_question_for_post","summary":"Create a new poll question for the Post You will be able to add questions after completing this step.","url":"\/api-documentation?category=community#ep-community-set_create_poll_question_for_post"},{"category":"community","method":"set_create_post","summary":"Composer endpoint - creates a post (or top-level reply) in a board. Wraps Community::CreatePost so iOS\/Android and the v2 web client share one path. Throttled to one post per 15 seconds per session (same as the legacy \/A","url":"\/api-documentation?category=community#ep-community-set_create_post"},{"category":"community","method":"set_create_review","summary":"Creates a verified review post for a location or a post-sale counterparty review request. Post-sale user ratings are request-bound: the server resolves the target board from ATReviewRequests and ignores client-selected u","url":"\/api-documentation?category=community#ep-community-set_create_review"},{"category":"community","method":"set_delete_post","summary":"Deletes a community post when the viewer has delete rights. Reuses Community::DeletePost(...) so moderator penalties, traderpoint reimbursement, and post-delete events remain shared with legacy.","url":"\/api-documentation?category=community#ep-community-set_delete_post"},{"category":"community","method":"set_edit_post","summary":"Changes a post in place, archiving its previous state only when content, attachments or destination change.","url":"\/api-documentation?category=community#ep-community-set_edit_post"},{"category":"community","method":"set_livestream_obs_key","summary":"Creates, resets or disables the owner's reusable OBS key. Reset and disable affect future connections; stop an active broadcast in OBS.","url":"\/api-documentation?category=community#ep-community-set_livestream_obs_key"},{"category":"community","method":"set_livestream_session","summary":"Creates a short-lived publishing grant for the post owner. The session becomes live only after SRS receives media.","url":"\/api-documentation?category=community#ep-community-set_livestream_session"},{"category":"community","method":"set_location_about_post","summary":"Sets or clears a location profile About post and optional image selections from that post's attached media. Any signed-in user may set the selected intro; only the post author may change the selected post title.","url":"\/api-documentation?category=community#ep-community-set_location_about_post"},{"category":"community","method":"set_newsfeed_filter_state","summary":"Saves the signed-in viewer's per-feed v2 newsfeed filter state.","url":"\/api-documentation?category=community#ep-community-set_newsfeed_filter_state"},{"category":"community","method":"set_post_action","summary":"Executes a visible action button for one community post. The client sends only the post ID and action row token. The server re-reads the post and merged action row, checks read access, asks the action class to render the","url":"\/api-documentation?category=community#ep-community-set_post_action"},{"category":"community","method":"set_post_forum","summary":"Moves a top-level community post into another forum with the same composer intent. Authors can move their own posts into same-intent forums they can write to. Global community forum-move admins can move any top-level pos","url":"\/api-documentation?category=community#ep-community-set_post_forum"},{"category":"community","method":"set_post_media_labels","summary":"Replace the author's live media labels, preserving individual attachments. POST with X-AT-Media-Request: 1 required. Only owned active labels may be linked.","url":"\/api-documentation?category=community#ep-community-set_post_media_labels"},{"category":"community","method":"set_post_public_release_date","summary":"Sets or clears the public release date for a top-level community post. Authors and users with GlobalCommunityAdministration can schedule posts for a future public release. Pass an empty value, `clear`, or `publish-now` t","url":"\/api-documentation?category=community#ep-community-set_post_public_release_date"},{"category":"community","method":"set_reaction","summary":"Sets, switches, or removes the caller's emoji reaction. An empty reactionKey removes the caller's reaction. The server enforces one active reaction per user per target, allowlisted keys only, target access, and no self-r","url":"\/api-documentation?category=community#ep-community-set_reaction"},{"category":"community","method":"set_record_post_big_view_open","summary":"Records that the viewer opened the immersive newsfeed post view. Public-by-design: this only updates the viewer's deduped community view row with aggregate open metadata and returns no private data; board access is still","url":"\/api-documentation?category=community#ep-community-set_record_post_big_view_open"},{"category":"community","method":"set_record_post_view","summary":"Records that the viewer has seen a newsfeed post. Public-by-design: community view counting already supports anonymous readers by IP and returns no private data; board access is still checked.","url":"\/api-documentation?category=community#ep-community-set_record_post_view"},{"category":"community","method":"set_report_post","summary":"Reports a community post to moderators. Reuses the legacy Community::ReportPost(...) path so moderator notification behavior stays shared with the old community container.","url":"\/api-documentation?category=community#ep-community-set_report_post"},{"category":"community","method":"set_shared_plan_join_decision","summary":"The sharing owner accepts or declines a request. Acceptance grants plan access and an approved private chat atomically.","url":"\/api-documentation?category=community#ep-community-set_shared_plan_join_decision"},{"category":"community","method":"set_shared_plan_join_request","summary":"Request admission to a shared plan. Comments do not create admission requests.","url":"\/api-documentation?category=community#ep-community-set_shared_plan_join_request"},{"category":"community","method":"set_socialite_event_application","summary":"Submit a private photography application, without publishing an event or granting membership.","url":"\/api-documentation?category=community#ep-community-set_socialite_event_application"},{"category":"community","method":"set_socialite_event_decision","summary":"Select or decline as the current president, or withdraw your own pending application.","url":"\/api-documentation?category=community#ep-community-set_socialite_event_decision"},{"category":"community","method":"set_submit_vote_for_question","summary":"Saves a poll answer","url":"\/api-documentation?category=community#ep-community-set_submit_vote_for_question"},{"category":"community","method":"set_thumbs_up","summary":"Toggles the current user's legacy thumbs-up reaction on a post. No active reaction sets thumbs_up; active thumbs_up removes it. Existing emoji reactions make this a compatibility wrapper for switching older clients back ","url":"\/api-documentation?category=community#ep-community-set_thumbs_up"},{"category":"community","method":"set_track_chat_mention_click","summary":"Records a click on a venue\/user mention inside a chat message. Used by the v2 chat dock before normal navigation. Venue clicks can make the sender eligible for the existing short direct-hire bid window.","url":"\/api-documentation?category=community#ep-community-set_track_chat_mention_click"},{"category":"community","method":"set_track_mention_click","summary":"Records a click on a post's tag\/mention chip. Backs the attribution chain that connects a post \u00e2\u2020\u2019 mention \u00e2\u2020\u2019 click \u00e2\u2020\u2019 transaction. Called via navigator.sendBeacon from the client so the request survives navigation. Pu","url":"\/api-documentation?category=community#ep-community-set_track_mention_click"},{"category":"community","method":"set_url_preview","summary":"Fetches, sanitizes, and stores a URL preview for an authenticated rich-input composer action. The preview fetch happens only on behalf of the creator before send. The saved card stores title\/description\/site metadata and","url":"\/api-documentation?category=community#ep-community-set_url_preview"},{"category":"concierge","method":"get_available_listing_container","summary":"Returns the exact-match direct-listing container for the v2 composer. Public-by-design: read-only renderer for already-public listing availability; listing purchase and offer placement keep their existing auth\/payment ga","url":"\/api-documentation?category=concierge#ep-concierge-get_available_listing_container"},{"category":"concierge","method":"get_available_listings","summary":"Returns sanitized direct listings for the v2 composer buy flow. For venue_availability, availablePrices maps each date to its lowest localized reservation price across all eligible inventory, before date filtering and pa","url":"\/api-documentation?category=concierge#ep-concierge-get_available_listings"},{"category":"concierge","method":"get_bid_listing_container","summary":"Returns the reusable v2 listing composer for an owned hold, an available normal bid, or an eligible Premium direct hire. Opening this form does not reserve the bid. Public normal direct submissions wait for seller select","url":"\/api-documentation?category=concierge#ep-concierge-get_bid_listing_container"},{"category":"concierge","method":"get_bid_price_guidance","summary":"Dedicated price guidance for the new minus\/plus bid editor. The legacy slider never uses this endpoint. Returns the suggested amount and actual comparable trades together. Five eligible venue trades support venue-only gu","url":"\/api-documentation?category=concierge#ep-concierge-get_bid_price_guidance"},{"category":"concierge","method":"get_bid_submission_edit_container","summary":"Opens the shared editor for the current submitter's saved answer, including rejection feedback and attachments.","url":"\/api-documentation?category=concierge#ep-concierge-get_bid_submission_edit_container"},{"category":"concierge","method":"get_buy_container","summary":"Returns the rich HTML + executable JS envelope for the v2 composer's buy CTA. Thin wrapper over the legacy \/API\/get_location_dialog.php endpoint (ATAIChatComponents::GetBidContainer) - battle-tested across many thousand ","url":"\/api-documentation?category=concierge#ep-concierge-get_buy_container"},{"category":"concierge","method":"get_categorize_request","summary":"Parses a free-form composer request into a per-intent checklist state. Drives the v2 composer's process-checklist UI: returns one entry per step (Intent -> Where -> What -> When), each marked done\/active\/todo based on wh","url":"\/api-documentation?category=concierge#ep-concierge-get_categorize_request"},{"category":"concierge","method":"get_classify_category","summary":"Classifies a composer request into one active marketplace category before the details parser runs. This keeps category meaning AI-classified while letting the later parser use a short, category-specific prompt. Public-by","url":"\/api-documentation?category=concierge#ep-concierge-get_classify_category"},{"category":"concierge","method":"get_classify_intent","summary":"Classifies the high-level intent of a free-form composer string into one of eight buckets so the v2 Intent Composer can pick the right rich UI BEFORE firing the heavier get_categorize_request parse. Uses a thin\/fast mode","url":"\/api-documentation?category=concierge#ep-concierge-get_classify_intent"},{"category":"concierge","method":"get_composer_board_options","summary":"Searches discussion boards available to the current viewer for the v2 Intent Composer board picker. Public-by-design: read-only forum lookup for logged-out composer parity. Restricted forums are filtered by Community per","url":"\/api-documentation?category=concierge#ep-concierge-get_composer_board_options"},{"category":"concierge","method":"get_composer_history","summary":"Get currently reusable suggestions from the acting user's submitted requests and published posts, followed by matching cached examples from other users. Render examples first, then fallbackExamples; both groups are addit","url":"\/api-documentation?category=concierge#ep-concierge-get_composer_history"},{"category":"concierge","method":"get_composer_render","summary":"Render the shared composer modal for opening or optional background preparation. Public-by-design: public profiles can open the same guest composer as the existing shell; posting and checkout retain their own authenticat","url":"\/api-documentation?category=concierge#ep-concierge-get_composer_render"},{"category":"concierge","method":"get_comps","summary":"Returns comparable-pricing data (slider Hot Zone bounds, fill-probability buckets, recent-fill marquee HTML) for a parsed concierge request. Wraps \/API\/GetComps.php. The composer reads MetaData.BidSliderData for slider m","url":"\/api-documentation?category=concierge#ep-concierge-get_comps"},{"category":"concierge","method":"get_copy_request_share","summary":"Returns the exact composer request text and whitelisted optional share state for a UUID-backed shared composer link. Public-by-design: possession of the opaque copy request UUID is the share credential; the response excl","url":"\/api-documentation?category=concierge#ep-concierge-get_copy_request_share"},{"category":"concierge","method":"get_global_concierge_count","summary":"Returns the global count of available \"fill-bid\" concierges, used by the v2 Intent Composer's empty state (\"{N} concierges waiting for requests\"). Wraps the same library call \/modules\/concierge\/index.php uses inline (\\AT","url":"\/api-documentation?category=concierge#ep-concierge-get_global_concierge_count"},{"category":"concierge","method":"get_intent_composer_result","summary":"Runs the full v2 Intent Composer parse pipeline in one request. This preserves the same modular stages as the granular endpoints, but calls them inside PHP so the browser avoids classify -> categorize -> get_buy_containe","url":"\/api-documentation?category=concierge#ep-concierge-get_intent_composer_result"},{"category":"concierge","method":"get_listing_container","summary":"Returns the rich HTML + executable JS envelope for the v2 composer's sell CTA. The public composer text is routing\/context only; exact listing details are collected in this structured container. Public-by-design: read-on","url":"\/api-documentation?category=concierge#ep-concierge-get_listing_container"},{"category":"concierge","method":"get_listing_edit_container","summary":"Returns the reusable v2 listing editor mounted for an off-market seller listing or rejected listing resubmit.","url":"\/api-documentation?category=concierge#ep-concierge-get_listing_edit_container"},{"category":"concierge","method":"get_listing_price_context","summary":"Returns sell-side price guidance for a listing draft. Wraps the same legacy \/API\/GetComps.php SellPageJS path used by templates\/sell\/sell.html, then normalizes the DOM-oriented response for the reusable v2 listing compos","url":"\/api-documentation?category=concierge#ep-concierge-get_listing_price_context"},{"category":"concierge","method":"get_localized_bidamount_and_fee","summary":"Returns the fee-inclusive bid amount, standard\/premium fees, and legal disclaimer strings for a given bid amount + location. The displayed CTA copy (\"Offer $171 to N concierges\") uses BidAmountInclStandardFee \/ 100, NOT ","url":"\/api-documentation?category=concierge#ep-concierge-get_localized_bidamount_and_fee"},{"category":"concierge","method":"get_location_options","summary":"Returns venue\/location options for reusable v2 composer selectors. Public-by-design: read-only same-site venue lookup for logged-out composer parity. Listing and review persistence are handled by later authenticated writ","url":"\/api-documentation?category=concierge#ep-concierge-get_location_options"},{"category":"concierge","method":"get_location_sellers","summary":"Returns the seller list, race-statement, and summary metrics (\"Secured N times\", \"starts working in N seconds\", \"X concierges will race...\") for a parsed concierge request at a specific bid amount. Wraps \/API\/get_locatio","url":"\/api-documentation?category=concierge#ep-concierge-get_location_sellers"},{"category":"concierge","method":"get_personalized_available_listings","summary":"Returns saved-city-market direct listings for the signed-in viewer's composer.","url":"\/api-documentation?category=concierge#ep-concierge-get_personalized_available_listings"},{"category":"concierge","method":"get_placeholder_examples","summary":"Returns public examples for the v2 Intent Composer typewriter and request bubbles. Public-by-design: the typewriter may be shown to logged-out viewers and only returns user-authored example text. When boardID is supplied","url":"\/api-documentation?category=concierge#ep-concierge-get_placeholder_examples"},{"category":"concierge","method":"get_request_completion","summary":"Autocomplete is disabled. Returns an empty suffix without AI calls for older composer clients. Public-by-design: compatibility response contains no user data and performs no inference.","url":"\/api-documentation?category=concierge#ep-concierge-get_request_completion"},{"category":"concierge","method":"get_request_example","summary":"Load complete request or forum example text, checking current visibility and board access. Public request examples remain reusable after cancellation, expiry, or fulfillment. Linked bid posts, including direct hires, reu","url":"\/api-documentation?category=concierge#ep-concierge-get_request_example"},{"category":"concierge","method":"get_request_price_guidance","summary":"Progressive reward suggestion for an unpaid general concierge request. Uses the median of up to ten most recently completed paid requests in the closest available canonical scope, broadening when that scope is empty. An ","url":"\/api-documentation?category=concierge#ep-concierge-get_request_price_guidance"},{"category":"concierge","method":"get_review_location_options","summary":"Returns venue\/location options for the v2 Intent Composer review panel. Public-by-design: read-only same-site venue lookup for logged-out composer parity. Review persistence is handled by a later authenticated write endp","url":"\/api-documentation?category=concierge#ep-concierge-get_review_location_options"},{"category":"concierge","method":"set_bid_listing","summary":"Updates an owned held answer, or submits complete inventory to an available bid without a prior hold. Normal direct fills respect seller selection. A seller in the buyer's current, unexpired direct-hire target list can a","url":"\/api-documentation?category=concierge#ep-concierge-set_bid_listing"},{"category":"concierge","method":"set_bid_submission_correction","summary":"Corrects an assigned, unapproved answer without releasing the bid. Confirmed eligible self-review completes it; other answers restart review.","url":"\/api-documentation?category=concierge#ep-concierge-set_bid_submission_correction"},{"category":"concierge","method":"set_copy_request_share_state","summary":"Saves the current optional, whitelisted composer share state for a UUID-backed request row immediately before the browser shares the link. Public-by-design: logged-out composers can share; writes still require matching S","url":"\/api-documentation?category=concierge#ep-concierge-set_copy_request_share_state"},{"category":"concierge","method":"set_hide_composer_history","summary":"Hide an owned item and duplicate wording from composer history across devices. Does not delete or cancel the underlying request or post.","url":"\/api-documentation?category=concierge#ep-concierge-set_hide_composer_history"},{"category":"concierge","method":"set_listing_media","summary":"Uploads a listing image and creates an ATMedia row that can be used by location\/set_listing image category fields.","url":"\/api-documentation?category=concierge#ep-concierge-set_listing_media"},{"category":"concierge","method":"set_purchase_checkout","summary":"Freeze the displayed composer purchase at payment initiation. No inference is performed. Public-by-design: guests can fund a general concierge brief; snapshot ownership stays session bound. General checkout is available ","url":"\/api-documentation?category=concierge#ep-concierge-set_purchase_checkout"},{"category":"concierge","method":"set_search_request_media","summary":"Stores ATMedia ids uploaded through the v2 Intent Composer on the matching custom-search request row. The search request is the durable handoff used later by Community::CreatePostFromComposer, so this endpoint only persi","url":"\/api-documentation?category=concierge#ep-concierge-set_search_request_media"},{"category":"customer_survey","method":"get_catalog","summary":"List AT and private templates, reusable fields, and optional chat recipient\/sales context. Never returns customer answers.","url":"\/api-documentation?category=customer_survey#ep-customer_survey-get_catalog"},{"category":"customer_survey","method":"get_customer_fields","summary":"Read own remembered values, or values this customer explicitly shared with the acting seller. Other sellers' responses are never returned.","url":"\/api-documentation?category=customer_survey#ep-customer_survey-get_customer_fields"},{"category":"customer_survey","method":"get_request","summary":"Read a questionnaire. Only its customer receives drafts, remembered prefills and memory revisions. Sellers receive submitted history only.","url":"\/api-documentation?category=customer_survey#ep-customer_survey-get_request"},{"category":"customer_survey","method":"get_requests","summary":"List only questionnaires sent or received by the acting user. Context filters never widen that access.","url":"\/api-documentation?category=customer_survey#ep-customer_survey-get_requests"},{"category":"customer_survey","method":"get_template","summary":"Read a versioned AT or seller-owned template for preview\/edit\/copy.","url":"\/api-documentation?category=customer_survey#ep-customer_survey-get_template"},{"category":"customer_survey","method":"set_attach","summary":"Attach a customer\/bid questionnaire to a completed sale between its original seller and customer. Existing sale links cannot be moved.","url":"\/api-documentation?category=customer_survey#ep-customer_survey-set_attach"},{"category":"customer_survey","method":"set_cancel","summary":"Cancel an unanswered questionnaire as its sending seller.","url":"\/api-documentation?category=customer_survey#ep-customer_survey-set_cancel"},{"category":"customer_survey","method":"set_draft","summary":"Save a customer-only draft. Drafts never update seller CRM or remembered values.","url":"\/api-documentation?category=customer_survey#ep-customer_survey-set_draft"},{"category":"customer_survey","method":"set_forget","summary":"Forget an own remembered value for future prefills. Existing seller-shared submissions remain unchanged.","url":"\/api-documentation?category=customer_survey#ep-customer_survey-set_forget"},{"category":"customer_survey","method":"set_send","summary":"Send one questionnaire to the server-resolved customer in an accepted chat. Reuse operationKey for retries only. Active bid selection pauses incoming questionnaires unless the sender has GlobalCommunityAdministration; Er","url":"\/api-documentation?category=customer_survey#ep-customer_survey-set_send"},{"category":"customer_survey","method":"set_submit","summary":"Confirm and share a new immutable response revision with this seller. Also updates customer memory and this seller's CRM pointers atomically.","url":"\/api-documentation?category=customer_survey#ep-customer_survey-set_submit"},{"category":"customer_survey","method":"set_template","summary":"Create or append an immutable template version. A system-field ID owns type, label and options; clients cannot redefine them. Answer types: text (single-line input), longtext (multiline textarea), number, boolean, single","url":"\/api-documentation?category=customer_survey#ep-customer_survey-set_template"},{"category":"customer_survey","method":"set_template_archive","summary":"Archive an owned template without changing sent questionnaires.","url":"\/api-documentation?category=customer_survey#ep-customer_survey-set_template_archive"},{"category":"discovery","method":"get_best_places","summary":"Get the AppointmentTrader city hotlist. Ranking is not evidence of available reservations. Public-by-design: exposes public city rankings, without account data or API charges.","url":"\/api-documentation?category=discovery#ep-discovery-get_best_places"},{"category":"discovery","method":"get_cities","summary":"Find canonical cities and airport-backed markets; choose among ambiguous matches. Public-by-design: exposes only public city metadata, without account data or API charges.","url":"\/api-documentation?category=discovery#ep-discovery-get_cities"},{"category":"discovery","method":"get_place","summary":"Read a public place and its valid inventory choices before checking a reservation price. Public-by-design: exposes public venue and inventory metadata, without account data or API charges.","url":"\/api-documentation?category=discovery#ep-discovery-get_place"},{"category":"discovery","method":"get_places","summary":"Search public place names and aliases. Resolve the intended place from these matches. Public-by-design: exposes public place metadata only, without account data or API charges.","url":"\/api-documentation?category=discovery#ep-discovery-get_places"},{"category":"discovery","method":"get_reservation_pricing","summary":"Check public listings and an indicative reservation acquisition price for a specific venue-local window. Historical comps, external references and configured defaults are labeled separately. This is not a checkout quote,","url":"\/api-documentation?category=discovery#ep-discovery-get_reservation_pricing"},{"category":"documentation","method":"get_search_index","summary":"Get a compact index of documented endpoints and category links. Public-by-design: guests can search the public API reference; restricted documentation requires developer access.","url":"\/api-documentation?category=documentation#ep-documentation-get_search_index"},{"category":"event","method":"get_available_events","summary":"Returns the webhook catalog, payload fields and examples available to this account.","url":"\/api-documentation?category=event#ep-event-get_available_events"},{"category":"event","method":"get_delivery","summary":"Returns one delivery payload and its most recent 100 attempts. Revoked resource access hides payload and response excerpts.","url":"\/api-documentation?category=event#ep-event-get_delivery"},{"category":"event","method":"get_delivery_history","summary":"Returns up to 50 deliveries, newest first. Pass the last ID as beforeID for the next page.","url":"\/api-documentation?category=event#ep-event-get_delivery_history"},{"category":"event","method":"get_status","summary":"Returns webhook queue health for your endpoints.","url":"\/api-documentation?category=event#ep-event-get_status"},{"category":"event","method":"get_subscriptions","summary":"Returns your endpoints and their selected event topics. Signing secrets are never included.","url":"\/api-documentation?category=event#ep-event-get_subscriptions"},{"category":"event","method":"set_delete_endpoint","summary":"Deletes an endpoint, cancels pending work and destroys its signing secrets. History remains for 90 days.","url":"\/api-documentation?category=event#ep-event-set_delete_endpoint"},{"category":"event","method":"set_endpoint","summary":"Creates or updates an HTTPS endpoint. URL changes cancel pending deliveries to the old URL. Select topics explicitly; there is no backfill.","url":"\/api-documentation?category=event#ep-event-set_endpoint"},{"category":"event","method":"set_resend","summary":"Resends an existing delivery to the current endpoint URL after current authorization checks. Event ID and payload remain unchanged; recipients must deduplicate.","url":"\/api-documentation?category=event#ep-event-set_resend"},{"category":"event","method":"set_rotate_secret","summary":"Rotates an endpoint signing secret. Both keys sign for 24 hours unless immediate revocation is requested.","url":"\/api-documentation?category=event#ep-event-set_rotate_secret"},{"category":"event","method":"set_subscribe","summary":"Subscribes an HTTPS URL to one event. Deliveries use signed JSON POST, not GET parameters.","url":"\/api-documentation?category=event#ep-event-set_subscribe"},{"category":"event","method":"set_test","summary":"Queues a signed webhook.test for your enabled endpoint; no business mutation occurs.","url":"\/api-documentation?category=event#ep-event-set_test"},{"category":"event","method":"set_unsubscribe","summary":"Removes a topic from an endpoint. Remaining deliveries for that topic are suppressed before sending.","url":"\/api-documentation?category=event#ep-event-set_unsubscribe"},{"category":"events","method":"get_event","summary":"Return the editable event payload for the rich event card editor. Requires the caller to be the event originator or hold GlobalCommunityAdministration.","url":"\/api-documentation?category=events#ep-events-get_event"},{"category":"events","method":"get_event_associated_venues","summary":"Returns venues associated with an event (i.e. venues that benefit from demand lift during the event's date window). Reads from the ATLocationEvents^ATLocation join table populated by set_event_venue_association.","url":"\/api-documentation?category=events#ep-events-get_event_associated_venues"},{"category":"events","method":"get_event_candidates","summary":"Search existing public-facing real-world events for composer attachment. Public-by-design: read-only public event picker candidate search for composer attachment.","url":"\/api-documentation?category=events#ep-events-get_event_candidates"},{"category":"events","method":"get_event_categories","summary":"Search existing event categories for the v2 composer event picker. Public-by-design: read-only public event picker category list for composer attachment.","url":"\/api-documentation?category=events#ep-events-get_event_categories"},{"category":"events","method":"get_event_location_options","summary":"Search physical-location choices for the rich event card map picker. Requires the caller to be the event originator or hold GlobalCommunityAdministration.","url":"\/api-documentation?category=events#ep-events-get_event_location_options"},{"category":"events","method":"get_event_occurrences","summary":"Return detailed occurrence rows for a selected public event. Public-by-design: read-only public event picker occurrence list for composer attachment.","url":"\/api-documentation?category=events#ep-events-get_event_occurrences"},{"category":"events","method":"get_event_place_details","summary":"Resolve a Google place\/address suggestion for the rich event card map picker. Requires the caller to be the event originator or hold GlobalCommunityAdministration.","url":"\/api-documentation?category=events#ep-events-get_event_place_details"},{"category":"events","method":"get_event_summary","summary":"Returns a single event resolved by URL slug. Includes the owning post URL so callers can route the user into the existing forum viewer for the full event view (per the events feature design \u2014 there is no dedicated event ","url":"\/api-documentation?category=events#ep-events-get_event_summary"},{"category":"events","method":"get_events_in_city","summary":"Returns real-world events whose effect radius covers a given city, OR whose pinned venue (Event-ATLocation_ID) is in that city, OR whose associated venues (ATLocationEvents^ATLocation) include any venue in that city. \"In","url":"\/api-documentation?category=events#ep-events-get_events_in_city"},{"category":"events","method":"get_events_near","summary":"Returns the top real-world events near a given lat\/long, ranked by geographic proximity then by next upcoming occurrence. Distance is computed against EventLocation (POINT) using ST_Distance_Sphere. Events pinned to a ve","url":"\/api-documentation?category=events#ep-events-get_events_near"},{"category":"events","method":"get_top_events","summary":"Returns the top real-world events globally, including ongoing occurrences. Filters to events with EventLocation set or Event-ATLocation_ID set so recurring weekday demand patterns and national holidays are excluded. Publ","url":"\/api-documentation?category=events#ep-events-get_top_events"},{"category":"events","method":"set_create_event","summary":"Create a real-world event from the v2 composer event picker. Requires CreateEvent. The permission defaults to true so staff can disable it only for users who abuse event creation.","url":"\/api-documentation?category=events#ep-events-set_create_event"},{"category":"events","method":"set_event","summary":"Edit an existing event. Empty \/ -1 sentinel values mean \"leave unchanged.\" Requires the caller to be the event originator or hold GlobalCommunityAdministration. Use \"__clear__\" for optional string\/list fields that should","url":"\/api-documentation?category=events#ep-events-set_event"},{"category":"events","method":"set_event_category","summary":"Create a reusable event category from the v2 composer event picker. Requires GlobalCommunityAdministration because event categories are global taxonomy, not per-post user content.","url":"\/api-documentation?category=events#ep-events-set_event_category"},{"category":"events","method":"set_event_location","summary":"Creates or proposes a missing location from an event surface, then keeps the resulting location tied to that event. Signed-in users with CreateEventLocationDirectly (or GlobalCommunityAdministration) create\/merge the ATL","url":"\/api-documentation?category=events#ep-events-set_event_location"},{"category":"events","method":"set_event_occurrence","summary":"Create a date\/time occurrence for an existing event from the composer picker. Requires CreateEvent, the same default-on abuse-control permission used for event creation. Event originators and GlobalCommunityAdministratio","url":"\/api-documentation?category=events#ep-events-set_event_occurrence"},{"category":"events","method":"set_event_venue_association","summary":"Add or remove an association between an event and a venue (ATLocation). Tags drive demand projections and the venue-transaction royalty.","url":"\/api-documentation?category=events#ep-events-set_event_venue_association"},{"category":"external_messaging","method":"get_billing_settings","summary":"Returns billing settings and the selected default AT funding account.","url":"\/api-documentation?category=external_messaging#ep-external_messaging-get_billing_settings"},{"category":"external_messaging","method":"get_channels","summary":"Returns supported external messaging channels.","url":"\/api-documentation?category=external_messaging#ep-external_messaging-get_channels"},{"category":"external_messaging","method":"get_delivery_health","summary":"Returns delivery health counters for the API user.","url":"\/api-documentation?category=external_messaging#ep-external_messaging-get_delivery_health"},{"category":"external_messaging","method":"get_events","summary":"Returns the event timeline for a message.","url":"\/api-documentation?category=external_messaging#ep-external_messaging-get_events"},{"category":"external_messaging","method":"get_identities","summary":"Returns sender identities owned by the API user.","url":"\/api-documentation?category=external_messaging#ep-external_messaging-get_identities"},{"category":"external_messaging","method":"get_identity_dns_status","summary":"Returns expected and last observed DNS state for an identity.","url":"\/api-documentation?category=external_messaging#ep-external_messaging-get_identity_dns_status"},{"category":"external_messaging","method":"get_message","summary":"Returns a queued\/sent message by numeric ID or UUID.","url":"\/api-documentation?category=external_messaging#ep-external_messaging-get_message"},{"category":"external_messaging","method":"get_messages","summary":"Returns recent messages for the API user.","url":"\/api-documentation?category=external_messaging#ep-external_messaging-get_messages"},{"category":"external_messaging","method":"get_suppressions","summary":"Returns active suppressions for the API user.","url":"\/api-documentation?category=external_messaging#ep-external_messaging-get_suppressions"},{"category":"external_messaging","method":"set_billing_account","summary":"Sets the default AT account used to pay for accepted production messages.","url":"\/api-documentation?category=external_messaging#ep-external_messaging-set_billing_account"},{"category":"external_messaging","method":"set_identity","summary":"Creates an email sender identity and returns the DNS records needed for verification.","url":"\/api-documentation?category=external_messaging#ep-external_messaging-set_identity"},{"category":"external_messaging","method":"set_identity_verify_dns","summary":"Checks DNS records for an email sender identity and marks it verified when required records are present.","url":"\/api-documentation?category=external_messaging#ep-external_messaging-set_identity_verify_dns"},{"category":"external_messaging","method":"set_send","summary":"Queues an external message. Phase one supports email only. Production email requires a verified sender identity and is charged after the first-party MTA records smtp_accepted. Sandbox messages are free and do not submit ","url":"\/api-documentation?category=external_messaging#ep-external_messaging-set_send"},{"category":"external_messaging","method":"set_suppression","summary":"Adds a user-level suppression for a recipient.","url":"\/api-documentation?category=external_messaging#ep-external_messaging-set_suppression"},{"category":"floorplan","method":"get_by_id","summary":"Returns one floorplan by ID with all floors, layouts, and areas hydrated. Used by the editor JS to refresh state after a write. Public-by-design: the floorplan tree itself isn't sensitive (the editor surface gates its ow","url":"\/api-documentation?category=floorplan#ep-floorplan-get_by_id"},{"category":"floorplan","method":"get_floor","summary":"Single-floor detail (architecture SVG + the floor's Active layout with all areas). Used by the editor when switching between floors. Public-by-design: same rationale as `get_for_location`.","url":"\/api-documentation?category=floorplan#ep-floorplan-get_floor"},{"category":"floorplan","method":"get_for_event","summary":"Returns Active floorplans linked to an `ATLocationEvents` row via `ATFloorplans.ATLocationEvent_ID`. Public-by-design: floorplans are reused across modules and apps; no sensitive content lives on this surface.","url":"\/api-documentation?category=floorplan#ep-floorplan-get_for_event"},{"category":"floorplan","method":"get_for_location","summary":"Returns the Active floorplans linked to an `ATLocation` via the direct `ATFloorplans.ATLocation_ID` column, with all floors, the currently- Active layout per floor, and every area on that layout. Returns an empty list (s","url":"\/api-documentation?category=floorplan#ep-floorplan-get_for_location"},{"category":"floorplan","method":"get_license_for_app","summary":"License lookup for a (floorplan, app) pair. Resolution order: 1. Per-app override row in `ATFloorplanLicenses` (Status='Active'). 2. Wildcard row (`ATApps_ID IS NULL`, Status='Active'). 3. Fall through to the `Permission","url":"\/api-documentation?category=floorplan#ep-floorplan-get_license_for_app"},{"category":"floorplan","method":"get_link_candidates","summary":"Creator-only link picker for floorplan creation. Returns normalized `ATV2SearchSelect` options for venues, events, or both. `results` is returned as a compatibility alias for older `ATV2Search` callers.","url":"\/api-documentation?category=floorplan#ep-floorplan-get_link_candidates"},{"category":"floorplan","method":"get_pending_review_list","summary":"Moderation queue: floorplans waiting for review. Gated by `Permission::CanReviewFloorplanSubmissions`.","url":"\/api-documentation?category=floorplan#ep-floorplan-get_pending_review_list"},{"category":"floorplan","method":"set_approved","summary":"Approve a Submitted floorplan, promoting it to Active. Floorplans are not exclusive per venue\/event -- multiple Active floorplans may share the same direct link -- so no supersede pass runs at this layer; the moderator c","url":"\/api-documentation?category=floorplan#ep-floorplan-set_approved"},{"category":"floorplan","method":"set_areas","summary":"Replace every area on a layout with the supplied list. The whole-list replace is intentional: the editor sends its current state, the server is the single source of truth on disk. Existing areas are soft-deleted (`Delete","url":"\/api-documentation?category=floorplan#ep-floorplan-set_areas"},{"category":"floorplan","method":"set_event_area","summary":"Tag an `ATLocationEvent` with a floorplan area. Same gate as `set_location_area`.","url":"\/api-documentation?category=floorplan#ep-floorplan-set_event_area"},{"category":"floorplan","method":"set_floor","summary":"Upsert a floor (architecture SVG, viewbox, name, order). Pass ATFloorplanFloor_ID = 0 to create a new floor under the supplied floorplan; non-zero updates the existing row. Architecture SVG is sanitised before write so u","url":"\/api-documentation?category=floorplan#ep-floorplan-set_floor"},{"category":"floorplan","method":"set_imported_svg","summary":"Import a pasted\/uploaded SVG fragment as the architecture layer of a floor. The fragment is sanitised server-side: script elements, event handlers (onload, onclick, ...), foreignObject elements, external references, and ","url":"\/api-documentation?category=floorplan#ep-floorplan-set_imported_svg"},{"category":"floorplan","method":"set_layout","summary":"Upsert a layout. Pass `ATFloorplanLayout_ID = 0` to create a new layout under the supplied floor; non-zero updates the existing row. When the resulting status is `Active`, ANY other Active layout on the same floor flips ","url":"\/api-documentation?category=floorplan#ep-floorplan-set_layout"},{"category":"floorplan","method":"set_location_area","summary":"Tag an `ATLocation` with a floorplan area so trades against that venue inherit area attribution for royalty purposes. Gated either by floorplan ownership OR `Permission::LocationAdministration`.","url":"\/api-documentation?category=floorplan#ep-floorplan-set_location_area"},{"category":"floorplan","method":"set_new","summary":"Direct creation entry point. Transactionally creates an ATFloorplans row (Draft), plus an initial ATFloorplanFloor (\"Ground\") and an initial ATFloorplanLayout (\"Default\", Active) so the editor has somewhere to draw immed","url":"\/api-documentation?category=floorplan#ep-floorplan-set_new"},{"category":"floorplan","method":"set_rejected","summary":"Reject a Submitted floorplan with a reviewer note. Gated by `Permission::CanReviewFloorplanSubmissions`.","url":"\/api-documentation?category=floorplan#ep-floorplan-set_rejected"},{"category":"floorplan","method":"set_submitted_for_review","summary":"Move a Draft floorplan into the moderation queue. Owner-only.","url":"\/api-documentation?category=floorplan#ep-floorplan-set_submitted_for_review"},{"category":"infractions","method":"get_bounty_estimate","summary":"Estimate the maximum USD bounty for a signed-in reporter using the current type, reported user's penalty permission and reporter's bounty rate. Assumes a full contribution share; staff decides the actual outcome and may ","url":"\/api-documentation?category=infractions#ep-infractions-get_bounty_estimate"},{"category":"infractions","method":"get_my_reports","summary":"Get only reports submitted by the acting user, including when the caller is staff. Reports against the caller are excluded. Merged reports retain their private chat and use the current case status and classification.","url":"\/api-documentation?category=infractions#ep-infractions-get_my_reports"},{"category":"infractions","method":"get_options","summary":"Get reportable types or staff configuration, numeric permissions and audit history.","url":"\/api-documentation?category=infractions#ep-infractions-get_options"},{"category":"infractions","method":"get_report_context","summary":"Resolve report context from a listing, participant-owned transaction, accessible chat or reported user. Chat targets use structured context or the sole other participant; ambiguous groups leave the user unselected.","url":"\/api-documentation?category=infractions#ep-infractions-get_report_context"},{"category":"infractions","method":"get_report_transactions","summary":"Resolve an exact transaction reference for a signed-in reporter, regardless of ownership. Staff verifies the connection to the reported user. Only pending\/completed marketplace transactions and non-deleted recorded custo","url":"\/api-documentation?category=infractions#ep-infractions-get_report_transactions"},{"category":"infractions","method":"set_report","summary":"Submit a private infraction report with optional uploaded images, videos or PDFs. Attachments and later evidence-chat uploads are linked to the report and visible only to its reporter and authorized reviewers.","url":"\/api-documentation?category=infractions#ep-infractions-set_report"},{"category":"listing","method":"get_competing_listings","summary":"Lists competing listings in a certain timeframe, along with pricing information","url":"\/api-documentation?category=listing#ep-listing-get_competing_listings"},{"category":"listing","method":"get_discount_viewers","summary":"List eligible signed-in viewers from the last 30 days. Only the current listing owner may read this audience.","url":"\/api-documentation?category=listing#ep-listing-get_discount_viewers"},{"category":"listing","method":"get_portfolio_listings","summary":"Legacy alias for \/v1\/portfolio\/get_listings","url":"\/api-documentation?category=listing#ep-listing-get_portfolio_listings"},{"category":"listing","method":"get_viewer_discount_preview","summary":"Preview a seller-funded fixed-amount offer. Public price stays unchanged; fees use the discounted price.","url":"\/api-documentation?category=listing#ep-listing-get_viewer_discount_preview"},{"category":"listing","method":"get_viewer_discount_status","summary":"Read delivery progress for an offer belonging to the current listing owner.","url":"\/api-documentation?category=listing#ep-listing-get_viewer_discount_status"},{"category":"listing","method":"set_archive","summary":"Archive Listing","url":"\/api-documentation?category=listing#ep-listing-set_archive"},{"category":"listing","method":"set_begin_transfer","summary":"Start working on a transfer-service listing.","url":"\/api-documentation?category=listing#ep-listing-set_begin_transfer"},{"category":"listing","method":"set_cancel_bid","summary":"Cancels a bid","url":"\/api-documentation?category=listing#ep-listing-set_cancel_bid"},{"category":"listing","method":"set_cancel_transfer_service","summary":"Cancel transfer service for a seller-owned listing.","url":"\/api-documentation?category=listing#ep-listing-set_cancel_transfer_service"},{"category":"listing","method":"set_complete_transfer","summary":"Mark a transfer-service listing as successfully transferred.","url":"\/api-documentation?category=listing#ep-listing-set_complete_transfer"},{"category":"listing","method":"set_create_from_template","summary":"Creates an appointment from a template, only appointments owned by api user may be copied. With publishListing and discardTemplateListing true, a locked Private reservation is relisted in place at the selected price in u","url":"\/api-documentation?category=listing#ep-listing-set_create_from_template"},{"category":"listing","method":"set_delete_review","summary":"Take a listing out of review and delete it.","url":"\/api-documentation?category=listing#ep-listing-set_delete_review"},{"category":"listing","method":"set_fail_transfer","summary":"Mark a transfer-service listing as failed.","url":"\/api-documentation?category=listing#ep-listing-set_fail_transfer"},{"category":"listing","method":"set_fill_bid","summary":"Fills a bid with a portfolio bid answer that is either off market or publicly available to fill a bid with a new bid answer please use \/v1\/location\/set_listing An ordinary pickup requiring an auction returns auctionRequi","url":"\/api-documentation?category=listing#ep-listing-set_fill_bid"},{"category":"listing","method":"set_market_visibility","summary":"Changes the visibility in the market. In the portal private listings appear in the private section and public in 'Publicly traded listings'","url":"\/api-documentation?category=listing#ep-listing-set_market_visibility"},{"category":"listing","method":"set_price","summary":"Changes the current listing price","url":"\/api-documentation?category=listing#ep-listing-set_price"},{"category":"listing","method":"set_purchase","summary":"Purchase a listing","url":"\/api-documentation?category=listing#ep-listing-set_purchase"},{"category":"listing","method":"set_send_viewer_discount","summary":"Send one private offer per viewer per listing through normal notifications. Reuse requestID for uncertain retries.","url":"\/api-documentation?category=listing#ep-listing-set_send_viewer_discount"},{"category":"listing","method":"set_unarchive","summary":"Restore an archived listing to its previous market visibility.","url":"\/api-documentation?category=listing#ep-listing-set_unarchive"},{"category":"listing","method":"set_update","summary":"Updates an off-market seller listing using the same structured listing fields as the v2 listing composer.","url":"\/api-documentation?category=listing#ep-listing-set_update"},{"category":"location","method":"get_address_suggestions","summary":"Searches the self-hosted worldwide address dataset. Use HTTPS POST to keep address queries out of URL logs. Authenticated sessions work before identity approval; external clients use the existing AT API-key eligibility r","url":"\/api-documentation?category=location#ep-location-get_address_suggestions"},{"category":"location","method":"get_category","summary":"Returns the locations category type (f.i. Restaurant or Prepaid-Restaurant) and the required field list for listings of this category. Public-by-design: location category metadata and listing field requirements are publi","url":"\/api-documentation?category=location#ep-location-get_category"},{"category":"location","method":"get_category_list","summary":"Searches all categories","url":"\/api-documentation?category=location#ep-location-get_category_list"},{"category":"location","method":"get_city_list","summary":"Searches all cities","url":"\/api-documentation?category=location#ep-location-get_city_list"},{"category":"location","method":"get_comparable_trades","summary":"Returns comparable price information for any inventory type and date.","url":"\/api-documentation?category=location#ep-location-get_comparable_trades"},{"category":"location","method":"get_follow_recommendations","summary":"Related venue exploration for the follow dialog, excluding locations already followed.","url":"\/api-documentation?category=location#ep-location-get_follow_recommendations"},{"category":"location","method":"get_inventory_types","summary":"Returns the inventory types available for the requested location.","url":"\/api-documentation?category=location#ep-location-get_inventory_types"},{"category":"location","method":"get_list","summary":"Searches all location aliasses","url":"\/api-documentation?category=location#ep-location-get_list"},{"category":"location","method":"get_metric_history","summary":"Returns history of location metrics across a defined timeframe","url":"\/api-documentation?category=location#ep-location-get_metric_history"},{"category":"location","method":"get_metrics","summary":"Returns detailed 90 day location trading metrics","url":"\/api-documentation?category=location#ep-location-get_metrics"},{"category":"location","method":"get_new_location_duplicate_options","summary":"Returns possible existing locations before a user proposes a missing venue. Public-by-design: read-only same-site duplicate suggestions are shown before submit so logged-out users can see whether a venue already exists b","url":"\/api-documentation?category=location#ep-location-get_new_location_duplicate_options"},{"category":"location","method":"get_profile","summary":"Returns public profile metadata and regulation-derived capabilities for a location. Historical seller trackrecords are available on public community profiles, including regulated venues without marketplace access. Their ","url":"\/api-documentation?category=location#ep-location-get_profile"},{"category":"location","method":"get_related_location_list","summary":"Returns locations that are related to locationAlias","url":"\/api-documentation?category=location#ep-location-get_related_location_list"},{"category":"location","method":"set_confirm_proposed_location","summary":"Confirms a proposed missing location. Three distinct eligible confirmations promote it into ATLocation.","url":"\/api-documentation?category=location#ep-location-set_confirm_proposed_location"},{"category":"location","method":"set_follow","summary":"Follow or unfollow a location with one relationship. Current buyer profiles receive offer alerts; current seller profiles receive matching bid invitations. General venue updates use all followers; following does not gran","url":"\/api-documentation?category=location#ep-location-set_follow"},{"category":"location","method":"set_general_opening_hours","summary":"Set a locations opening hours.","url":"\/api-documentation?category=location#ep-location-set_general_opening_hours"},{"category":"location","method":"set_inventory_type","summary":"Creates a location-specific inventory type when no existing type has the requested name.","url":"\/api-documentation?category=location#ep-location-set_inventory_type"},{"category":"location","method":"set_listing","summary":"Submits a new listing for review or if the user has the Permission::SelfReviewListings the listing will be approved. If the timeframe and price matches a vacant bid, the bid will be filled automatically. Please keep in m","url":"\/api-documentation?category=location#ep-location-set_listing"},{"category":"location","method":"set_proposed_location","summary":"Posts a proposed missing location to a city board for community verification.","url":"\/api-documentation?category=location#ep-location-set_proposed_location"},{"category":"location","method":"set_subscribe_to_city_area_priority_bids","summary":"Subscribe to Concierge Bids for the Area You will receive a message each time when a bid is placed in the region.","url":"\/api-documentation?category=location#ep-location-set_subscribe_to_city_area_priority_bids"},{"category":"location","method":"set_subscribe_to_location_priority_bids","summary":"Subscribe to Insider Bids You will receive a message each time when a bid is placed for this location.","url":"\/api-documentation?category=location#ep-location-set_subscribe_to_location_priority_bids"},{"category":"location","method":"set_unlock_exact_listing_times","summary":"Unlock Exact Listing Times You will be able to see all exact listing start times for this day after unlocking.","url":"\/api-documentation?category=location#ep-location-set_unlock_exact_listing_times"},{"category":"location","method":"set_unsubscribe_from_city_area_priority_bids","summary":"Unsubscribe from Concierge Bids for the Area You will no longer receive a message each time when a bid is placed in the region.","url":"\/api-documentation?category=location#ep-location-set_unsubscribe_from_city_area_priority_bids"},{"category":"location","method":"set_unsubscribe_from_location_priority_bids","summary":"Unsubscribe from Insider Bids You will no longer receive a message each time when a bid is placed for this location.","url":"\/api-documentation?category=location#ep-location-set_unsubscribe_from_location_priority_bids"},{"category":"marketdata","method":"get_city_hot_list","summary":"Returns the most-traded venues in a given city, with rank-change deltas. Powers the per-city Hot List page at \/market-data\/.","url":"\/api-documentation?category=marketdata#ep-marketdata-get_city_hot_list"},{"category":"marketdata","method":"get_continent_country_top","summary":"Returns the top cities of an editorial continent, grouped by country. Editorial continents are: NA (North America incl. Canada\/Mexico), EU (Europe), AS (Asia, excluding Middle East), MEA (Middle East & Africa), SA (South","url":"\/api-documentation?category=marketdata#ep-marketdata-get_continent_country_top"},{"category":"marketdata","method":"get_highest_converting_locations","summary":"Returns the best converting venues, indicating the most demand for listings","url":"\/api-documentation?category=marketdata#ep-marketdata-get_highest_converting_locations"},{"category":"marketdata","method":"get_map_points","summary":"Returns signed-in Market Data map points for overview and city Hot List map panels.","url":"\/api-documentation?category=marketdata#ep-marketdata-get_map_points"},{"category":"marketdata","method":"get_most_bids_least_asks","summary":"Returns locations with the highest bids vs listing ratio","url":"\/api-documentation?category=marketdata#ep-marketdata-get_most_bids_least_asks"},{"category":"marketdata","method":"get_most_underserved_locations","summary":"Returns locations with the most bids and the least number of listings in the past 30 days","url":"\/api-documentation?category=marketdata#ep-marketdata-get_most_underserved_locations"},{"category":"marketdata","method":"get_most_viewed_locations_with_least_listings","summary":"Returns the most viewed locations with the least amount of listings","url":"\/api-documentation?category=marketdata#ep-marketdata-get_most_viewed_locations_with_least_listings"},{"category":"marketdata","method":"get_recently_viewed","summary":"Returns signed-in caller-scoped recently viewed listings, marketplace locations, cities, communities, profiles, plus viewer-owned My Bookings and active request tiles when available. Public-by-design: anonymous callers d","url":"\/api-documentation?category=marketdata#ep-marketdata-get_recently_viewed"},{"category":"marketdata","method":"get_required_inventory_forecast","summary":"Returns inventory that may have high chance of selling based on historical data","url":"\/api-documentation?category=marketdata#ep-marketdata-get_required_inventory_forecast"},{"category":"marketdata","method":"get_toplist","summary":"Returns locations with the most bids and the least number of listings in the past 30 days","url":"\/api-documentation?category=marketdata#ep-marketdata-get_toplist"},{"category":"marketdata","method":"get_trending_near","summary":"Returns the cities trending closest to a given lat\/long. Resolves the closest city via ATAirport proximity, then returns cities within that city's continent ordered by distance, using activity as the tie-breaker. Used by","url":"\/api-documentation?category=marketdata#ep-marketdata-get_trending_near"},{"category":"marketdata","method":"get_wall_of_fame","summary":"Returns all public Wall of Fame leaderboards for the requested scope and timeframe. Public-by-design: Wall of Fame cards expose public user aliases, avatars, selected public profile\/banner images, profile links, ranks, t","url":"\/api-documentation?category=marketdata#ep-marketdata-get_wall_of_fame"},{"category":"marketdata","method":"get_wall_of_fame_list","summary":"Returns one public Wall of Fame leaderboard. Public-by-design: the response intentionally excludes exact raw cents and only emits rounded public amount labels plus public user identity fields and selected public profile\/","url":"\/api-documentation?category=marketdata#ep-marketdata-get_wall_of_fame_list"},{"category":"marketdata","method":"get_world_top","summary":"Returns the top cities worldwide ordered by recent trading activity. Used by the Market Data overview page's \"World's Top N\" header section.","url":"\/api-documentation?category=marketdata#ep-marketdata-get_world_top"},{"category":"medal","method":"get_available_medal_categories","summary":"Searches all available medal categories on the platform","url":"\/api-documentation?category=medal#ep-medal-get_available_medal_categories"},{"category":"medal","method":"get_profile_sponsorships","summary":"Returns the viewed user's current medal sponsor and directly sponsored users, with public identities only. Public-by-design: approved sponsorships are visible only when the caller can view both related profiles.","url":"\/api-documentation?category=medal#ep-medal-get_profile_sponsorships"},{"category":"medal","method":"set_request_medal_sponsorship","summary":"Request Medal Sponsorship will be asked to sponsor the medal defined below for you.","url":"\/api-documentation?category=medal#ep-medal-set_request_medal_sponsorship"},{"category":"medal","method":"set_sponsor_user","summary":"Sponsor A Medal for will be recommended for the medal you define below.","url":"\/api-documentation?category=medal#ep-medal-set_sponsor_user"},{"category":"media","method":"get_ftp_credentials","summary":"Read the acting account's generated FTP login. Passwords are recoverable only by the app. Send POST with X-AT-Media-Request: 1. Never put credentials in URLs or client storage.","url":"\/api-documentation?category=media#ep-media-get_ftp_credentials"},{"category":"media","method":"get_ftp_logs","summary":"Read upload logs through the acting account's FTPS connection. Latest 30 UTC dates, up to 64 KiB of the selected log's tail. Send POST with X-AT-Media-Request: 1. No credentials or owner IDs are accepted.","url":"\/api-documentation?category=media#ep-media-get_ftp_logs"},{"category":"media","method":"get_labels","summary":"Private label catalog, including archived labels. Never accepts another account ID.","url":"\/api-documentation?category=media#ep-media-get_labels"},{"category":"media","method":"get_my_media","summary":"Browse retained media owned by the acting account. Never accepts another account ID.","url":"\/api-documentation?category=media#ep-media-get_my_media"},{"category":"media","method":"get_my_media_item","summary":"Preview one owned file with current permission-checked usage references. Chat usages include chatID only after current chat and message access checks; their URL opens the conversation. File ownership alone never grants a","url":"\/api-documentation?category=media#ep-media-get_my_media_item"},{"category":"media","method":"get_my_media_timeline","summary":"Return creation months for the account's current media filters.","url":"\/api-documentation?category=media#ep-media-get_my_media_timeline"},{"category":"media","method":"set_copy_post_photo","summary":"Copy an accessible post photo into the acting user's media library with a new ID and the same file URLs. Also resolves the acting user's wall for the About Me composer; creates that wall if needed. Does not publish a pos","url":"\/api-documentation?category=media#ep-media-set_copy_post_photo"},{"category":"media","method":"set_delete_file","summary":"Soft-delete a file owned by the acting account by setting ATMedia.DeletedDate. The stored file and reference rows are retained. Deleted media is excluded from My Media, attachment selection and owner downloads. Repeating","url":"\/api-documentation?category=media#ep-media-set_delete_file"},{"category":"media","method":"set_ftp_credentials","summary":"Create a random FTP login with six uppercase A-Z letters in each field, or reset it. Reset preserves an existing six-letter uppercase username; legacy names are shortened. The home-directory slug, virtual identity, defau","url":"\/api-documentation?category=media#ep-media-set_ftp_credentials"},{"category":"media","method":"set_ftp_label","summary":"Set a credential's default label independently of its password. Records upload-time history atomically. POST with X-AT-Media-Request: 1 required. Resetting credentials preserves this setting and upload directory.","url":"\/api-documentation?category=media#ep-media-set_ftp_label"},{"category":"media","method":"set_ftp_notifications","summary":"Enable\/disable priority alerts for successful FTP imports. Defaults to on for new and existing credentials. Changes apply to future imports, including uploads awaiting delivery. Existing alerts and replayed imports are u","url":"\/api-documentation?category=media#ep-media-set_ftp_notifications"},{"category":"media","method":"set_import_from_url","summary":"Download one public HTTP(S) media URL into the acting account's My Media library. Accepts JPEG, PNG, GIF, WebP, AVIF, MP4, MOV, WebM and PDF, up to 25 MiB. Send POST with X-AT-Media-Request: 1. Authenticated session or o","url":"\/api-documentation?category=media#ep-media-set_import_from_url"},{"category":"media","method":"set_label","summary":"Create or rename an owned label; archived names remain reserved. POST with X-AT-Media-Request: 1.","url":"\/api-documentation?category=media#ep-media-set_label"},{"category":"media","method":"set_label_archived","summary":"Archive or restore a label. Archiving atomically clears FTP defaults and records history; existing links remain. POST with X-AT-Media-Request: 1 required.","url":"\/api-documentation?category=media#ep-media-set_label_archived"},{"category":"media","method":"set_media_labels","summary":"Atomically add\/remove labels on up to 100 owned, retained media. Unrelated links are preserved. Archived labels may be removed but never manually added. POST with X-AT-Media-Request: 1 required.","url":"\/api-documentation?category=media#ep-media-set_media_labels"},{"category":"notification","method":"get_detail","summary":"Returns the full non-chat notification payload for a modal or deep link. Chat notifications are intentionally excluded; those belong to the v2 Messages\/chat dock flow.","url":"\/api-documentation?category=notification#ep-notification-get_detail"},{"category":"notification","method":"get_list","summary":"Returns the most recent notifications for the authenticated user. The result is a single list sorted newest-first. Each item carries a readState ('Created' | 'Pushed' | 'SentViaEmail' | 'Read') and an isUnread boolean so","url":"\/api-documentation?category=notification#ep-notification-get_list"},{"category":"notification","method":"get_preview","summary":"Returns a compact, authenticated preview for one notification. Used by the ATV2 realtime preview banner after the WebSocket nudge tells the browser which notification row changed. The socket carries only the notification","url":"\/api-documentation?category=notification#ep-notification-get_preview"},{"category":"notification","method":"get_recipients","summary":"Returns recipient\/read-state information for one non-chat notification. A protected bid customer has null identity fields and identityHidden=true until the saved race closing time.","url":"\/api-documentation?category=notification#ep-notification-get_recipients"},{"category":"notification","method":"get_type_preferences","summary":"Returns this user's notification type priority overrides. Overrides affect future messages only.","url":"\/api-documentation?category=notification#ep-notification-get_type_preferences"},{"category":"notification","method":"get_web_push_registration","summary":"Returns whether the current browser session already has a Web Push token. Android PWA clients call this on startup after browser notification permission has already been granted. It lets the app hide the notification ena","url":"\/api-documentation?category=notification#ep-notification-get_web_push_registration"},{"category":"notification","method":"set_action","summary":"Executes a non-chat notification action button owned by the caller. Preferred clients send actionButtonID from get_detail\/get_list. For older notification actions that never created an action row, send notificationID plu","url":"\/api-documentation?category=notification#ep-notification-set_action"},{"category":"notification","method":"set_all_read","summary":"Marks every unread non-chat notification for the authenticated user as read. The native v2 notifications dashboard calls this once on open so the page behaves like an inbox visit rather than only marking the first lazy-l","url":"\/api-documentation?category=notification#ep-notification-set_all_read"},{"category":"notification","method":"set_delete","summary":"Soft-deletes one notification owned by the authenticated user. The notification row remains in ATNotifications for audit\/history, but DeletedDate is set so native v2 notification lists and unread counts no longer show it","url":"\/api-documentation?category=notification#ep-notification-set_delete"},{"category":"notification","method":"set_readstate","summary":"Changes the visibility of the notifications in the ID list In the portal private listings appear in the private section and public in 'Publicly traded listings'","url":"\/api-documentation?category=notification#ep-notification-set_readstate"},{"category":"notification","method":"set_type_priority","summary":"Sets the acting user's priority for future notifications of a registered type. Default removes the override. Existing notifications and pending deliveries retain their creation-time priority.","url":"\/api-documentation?category=notification#ep-notification-set_type_priority"},{"category":"notification","method":"set_web_push_registration","summary":"Registers or clears the current browser session's Firebase Web Push token. Android PWA clients call this after the user grants browser notification permission. The token is stored on the current ATUserSession so the exis","url":"\/api-documentation?category=notification#ep-notification-set_web_push_registration"},{"category":"partner","method":"get_bulk_availability_template","summary":"Get the CSV columns and example row for bulk venue availability imports.","url":"\/api-documentation?category=partner#ep-partner-get_bulk_availability_template"},{"category":"partner","method":"get_inventory","summary":"Get location-specific inventory types and linked community posts for a managed venue.","url":"\/api-documentation?category=partner#ep-partner-get_inventory"},{"category":"partner","method":"get_listing_regulation_policy","summary":"Get the venue listing-regulation override policy for a managed venue.","url":"\/api-documentation?category=partner#ep-partner-get_listing_regulation_policy"},{"category":"partner","method":"get_location_claim_options","summary":"Search venues that can be selected for a partner management claim.","url":"\/api-documentation?category=partner#ep-partner-get_location_claim_options"},{"category":"partner","method":"get_location_dashboard","summary":"Get overview demand, listing, sales, and conversion signals for a managed venue.","url":"\/api-documentation?category=partner#ep-partner-get_location_dashboard"},{"category":"partner","method":"get_location_inventory_forecast","summary":"Get a managed venue's inventory forecast using the same market-insight engine as the seller forecast, without public API pricing.","url":"\/api-documentation?category=partner#ep-partner-get_location_inventory_forecast"},{"category":"partner","method":"get_location_likeness_group","summary":"Get saved similar restaurants and suggested related restaurants for a managed venue forecast.","url":"\/api-documentation?category=partner#ep-partner-get_location_likeness_group"},{"category":"partner","method":"get_location_likeness_options","summary":"Search restaurants that can be added to a managed venue's similarity group.","url":"\/api-documentation?category=partner#ep-partner-get_location_likeness_options"},{"category":"partner","method":"get_location_livestream","summary":"Get the featured livestream post for a managed venue.","url":"\/api-documentation?category=partner#ep-partner-get_location_livestream"},{"category":"partner","method":"get_locations","summary":"Get the venue locations this user personally manages through partner team roles or legacy location-user grants, plus their pending venue management applications. Global administrator access alone does not add locations.","url":"\/api-documentation?category=partner#ep-partner-get_locations"},{"category":"partner","method":"get_opening_hours","summary":"Get weekly recurring opening-hour windows for a venue the current user may edit.","url":"\/api-documentation?category=partner#ep-partner-get_opening_hours"},{"category":"partner","method":"get_team","summary":"Get active team members, pending invites, and recent partner audit events for a managed venue.","url":"\/api-documentation?category=partner#ep-partner-get_team"},{"category":"partner","method":"set_bulk_availability","summary":"Validate or create bulk dated availability for a managed venue. Created rows become normal ATAppointment listings.","url":"\/api-documentation?category=partner#ep-partner-set_bulk_availability"},{"category":"partner","method":"set_delete_location","summary":"Preview or delete a location for failing community standards. Deletion is admin-only and applies new-location reward penalties when applicable.","url":"\/api-documentation?category=partner#ep-partner-set_delete_location"},{"category":"partner","method":"set_inventory_type","summary":"Create or update a location-specific inventory type for a managed venue.","url":"\/api-documentation?category=partner#ep-partner-set_inventory_type"},{"category":"partner","method":"set_inventory_type_post_link","summary":"Link a community post to a venue inventory type.","url":"\/api-documentation?category=partner#ep-partner-set_inventory_type_post_link"},{"category":"partner","method":"set_listing_regulation_policy","summary":"Save the venue listing-regulation override policy. Only venue Owners\/Admins, legacy venue managers, and global community administrators may save.","url":"\/api-documentation?category=partner#ep-partner-set_listing_regulation_policy"},{"category":"partner","method":"set_location_claim_request","summary":"Request management access to a location. The request is sent to GlobalCommunityAdministration users in a chat with approve\/reject action buttons.","url":"\/api-documentation?category=partner#ep-partner-set_location_claim_request"},{"category":"partner","method":"set_location_likeness_group","summary":"Save the managed venue's similarity group used by partner inventory forecasts.","url":"\/api-documentation?category=partner#ep-partner-set_location_likeness_group"},{"category":"partner","method":"set_location_livestream_post","summary":"Feature a location-connected community post as the venue livestream station, or create a new station post and feature it.","url":"\/api-documentation?category=partner#ep-partner-set_location_livestream_post"},{"category":"partner","method":"set_opening_hours","summary":"Validate or save weekly recurring split opening hours for a managed venue.","url":"\/api-documentation?category=partner#ep-partner-set_opening_hours"},{"category":"partner","method":"set_team_invite","summary":"Create or accept a role-scoped venue team invite. Creating an invite preserves normal referral attribution through the returned URL's v parameter.","url":"\/api-documentation?category=partner#ep-partner-set_team_invite"},{"category":"partner","method":"set_team_member_remove","summary":"Remove a user from a venue team.","url":"\/api-documentation?category=partner#ep-partner-set_team_member_remove"},{"category":"partner","method":"set_team_member_role","summary":"Add an existing user to a venue team or change that user's partner role.","url":"\/api-documentation?category=partner#ep-partner-set_team_member_role"},{"category":"portfolio","method":"get_last_order_list_id","summary":"Returns the order list that has been used last by the api user","url":"\/api-documentation?category=portfolio#ep-portfolio-get_last_order_list_id"},{"category":"portfolio","method":"get_listings","summary":"Returns all listings in the users portfolio.","url":"\/api-documentation?category=portfolio#ep-portfolio-get_listings"},{"category":"portfolio","method":"get_my_appointments_grouped_by_city","summary":"Returns the authenticated viewer's appointments grouped by city, with separate counts for upcoming (Date >= today) and past (Date < today) rows. Powers the v2 sidebar's \"My Bookings\" block. Each group carries the city's ","url":"\/api-documentation?category=portfolio#ep-portfolio-get_my_appointments_grouped_by_city"},{"category":"portfolio","method":"get_my_calendar_items","summary":"Returns every time-bound item belonging to the viewer that falls in the window [from, to], normalized into the CalendarItem shape consumed by \/modules\/v2\/travel_plans\/?view=calendar. P1 covers bids and appointments \u2014 the","url":"\/api-documentation?category=portfolio#ep-portfolio-get_my_calendar_items"},{"category":"portfolio","method":"get_my_travel_plan_archived","summary":"Archived travel plans for the v2 \"My Bookings\" archive view. Returns a newest-first list of the viewer's archived appointments, each carrying the city payload used by the normal My Bookings landing page.","url":"\/api-documentation?category=portfolio#ep-portfolio-get_my_travel_plan_archived"},{"category":"portfolio","method":"get_my_travel_plan_detail","summary":"Per-city travel plan detail \u2014 the v2 city detail page's data source. Returns the city's display data plus the viewer's appointments and active bids in that city. Appointment windows: upcoming = from two calendar days ago","url":"\/api-documentation?category=portfolio#ep-portfolio-get_my_travel_plan_detail"},{"category":"portfolio","method":"get_my_travel_plan_upcoming","summary":"Travel plans by time window \u2014 the v2 \"My Bookings\" landing page data. Returns a flat chronological list of the viewer's recent and upcoming appointments\/listings, plus active bids and upcoming seller-sold sales through t","url":"\/api-documentation?category=portfolio#ep-portfolio-get_my_travel_plan_upcoming"},{"category":"portfolio","method":"get_my_travel_plans","summary":"Travel plans by city \u2014 the v2 sidebar's \"My Bookings\" data source. Returns one group per city the viewer has activity in, where activity is the union of: - My Bookings appointments owned by or shared with the viewer (ATA","url":"\/api-documentation?category=portfolio#ep-portfolio-get_my_travel_plans"},{"category":"portfolio","method":"get_order_list_items","summary":"Returns the order list items for $orderListID","url":"\/api-documentation?category=portfolio#ep-portfolio-get_order_list_items"},{"category":"portfolio","method":"get_order_lists","summary":"Returns all available orderlists","url":"\/api-documentation?category=portfolio#ep-portfolio-get_order_lists"},{"category":"portfolio","method":"get_valid_location_identifiers","summary":"Searches available location identifiers for purposes of creating a buy order","url":"\/api-documentation?category=portfolio#ep-portfolio-get_valid_location_identifiers"},{"category":"portfolio","method":"mint_calendar_feed_token","summary":"Returns the viewer's iCalendar subscription URL, minting a token on first call. Idempotent \u2014 subsequent calls return the same URL until the user explicitly revokes via set_revoke_calendar_feed_tokens. The URL is intentio","url":"\/api-documentation?category=portfolio#ep-portfolio-mint_calendar_feed_token"},{"category":"portfolio","method":"set_archive_my_travel_plan","summary":"Archives an owned reservation from v2 My Bookings. Archived plans are hidden from the upcoming\/past city tabs and collected under the Archived Plans view.","url":"\/api-documentation?category=portfolio#ep-portfolio-set_archive_my_travel_plan"},{"category":"portfolio","method":"set_bulk_bid_order","summary":"Create a Bulk Buy Order IN BETA - NOT YET FUNCTIONAL Placeholder only: with isWritingRequest=true the current implementation returns true without creating an order or placing bids.","url":"\/api-documentation?category=portfolio#ep-portfolio-set_bulk_bid_order"},{"category":"portfolio","method":"set_delete_order_list","summary":"Delete order list","url":"\/api-documentation?category=portfolio#ep-portfolio-set_delete_order_list"},{"category":"portfolio","method":"set_delete_order_list_item","summary":"Deletes an order list item","url":"\/api-documentation?category=portfolio#ep-portfolio-set_delete_order_list_item"},{"category":"portfolio","method":"set_my_travel_plan_share_details","summary":"Updates or removes a community share for an owned My Bookings appointment.","url":"\/api-documentation?category=portfolio#ep-portfolio-set_my_travel_plan_share_details"},{"category":"portfolio","method":"set_order_list","summary":"Create a new order list","url":"\/api-documentation?category=portfolio#ep-portfolio-set_order_list"},{"category":"portfolio","method":"set_order_list_item","summary":"Saves an order list item","url":"\/api-documentation?category=portfolio#ep-portfolio-set_order_list_item"},{"category":"portfolio","method":"set_rename_order_list","summary":"Rename order list","url":"\/api-documentation?category=portfolio#ep-portfolio-set_rename_order_list"},{"category":"portfolio","method":"set_revoke_calendar_feed_tokens","summary":"Revokes every active calendar-feed token for the viewer. Use this when the user clicks \"Regenerate URL\" in the Sync sheet \u2014 call mint after to issue a fresh one.","url":"\/api-documentation?category=portfolio#ep-portfolio-set_revoke_calendar_feed_tokens"},{"category":"portfolio","method":"set_suggest_list_to_user","summary":"Unimplemented list-suggestion endpoint. The dispatcher returns an internal-error envelope; no suggestion is sent.","url":"\/api-documentation?category=portfolio#ep-portfolio-set_suggest_list_to_user"},{"category":"portfolio","method":"set_unarchive_my_travel_plan","summary":"Restores an owned archived reservation from v2 My Bookings. The plan returns to its most recent non-archived status when that status is still supported by My Bookings; otherwise it falls back to Private.","url":"\/api-documentation?category=portfolio#ep-portfolio-set_unarchive_my_travel_plan"},{"category":"portfolio","method":"set_unlock_private_appointment","summary":"Unlocks a private reservation for personal use from v2 My Bookings. Unlocking reveals the exact start time and confirmation details. After a reservation is unlocked, resale must go through the regular offer and review pr","url":"\/api-documentation?category=portfolio#ep-portfolio-set_unlock_private_appointment"},{"category":"portfolio","method":"set_update_order_list_item_quantity","summary":"Updates the quantity of an item","url":"\/api-documentation?category=portfolio#ep-portfolio-set_update_order_list_item_quantity"},{"category":"reservation","method":"get_detail","summary":"Returns a native v2 reservation payload for the acting viewer. Public-by-design: anonymous share links reveal teaser metadata only; exact reservation details require sign-in.","url":"\/api-documentation?category=reservation#ep-reservation-get_detail"},{"category":"reservation","method":"get_transfer_detail","summary":"Returns read-only reservation details for a transfer chat participant. Requires the current buyer or assigned transfer agent and a matching transfer chat. Locked buyers receive a summary and time window, without private ","url":"\/api-documentation?category=reservation#ep-reservation-get_transfer_detail"},{"category":"reservation","method":"set_accept_sharecode","summary":"Accepts a share code for the acting signed-in user.","url":"\/api-documentation?category=reservation#ep-reservation-set_accept_sharecode"},{"category":"reservation","method":"set_approve_review","summary":"Approves a native reservation review for the acting reviewer.","url":"\/api-documentation?category=reservation#ep-reservation-set_approve_review"},{"category":"reservation","method":"set_begin_review","summary":"Begins native reservation review for the acting reviewer.","url":"\/api-documentation?category=reservation#ep-reservation-set_begin_review"},{"category":"reservation","method":"set_cancel_transfer_service","summary":"Cancels transfer service for the acting buyer's reservation, including transfer work already in progress.","url":"\/api-documentation?category=reservation#ep-reservation-set_cancel_transfer_service"},{"category":"reservation","method":"set_reject_review","summary":"Rejects a native reservation review for the acting reviewer.","url":"\/api-documentation?category=reservation#ep-reservation-set_reject_review"},{"category":"reservation","method":"set_request_transfer_service","summary":"Requests transfer service for the acting buyer's reservation.","url":"\/api-documentation?category=reservation#ep-reservation-set_request_transfer_service"},{"category":"seller","method":"get_capabilities","summary":"Returns the acting seller's current capability limits and readiness.","url":"\/api-documentation?category=seller#ep-seller-get_capabilities"},{"category":"seller","method":"get_dashboard","summary":"Returns the seller dashboard overview for the acting user.","url":"\/api-documentation?category=seller#ep-seller-get_dashboard"},{"category":"seller","method":"get_listing_intelligence","summary":"Returns listing-level customer view trends and pricing intelligence for listings owned by the acting seller.","url":"\/api-documentation?category=seller#ep-seller-get_listing_intelligence"},{"category":"seller","method":"get_market_insight_location_report","summary":"Returns a sellability report for one venue in My Sales Market Insights. The report groups likely sellable inventory by inventory type, date, and timeframe, then adds active public competition already listed for each row.","url":"\/api-documentation?category=seller#ep-seller-get_market_insight_location_report"},{"category":"seller","method":"get_market_insight_locations","summary":"Returns ranked venues for one seller market insight city. The payload is loaded separately from the main market insights response so large venue strips can hydrate as each market tile comes into view.","url":"\/api-documentation?category=seller#ep-seller-get_market_insight_locations"},{"category":"seller","method":"get_market_insights","summary":"Returns forward-looking seller market insights for the selected time window. The payload ranks city markets using same-calendar-window historical transaction demand from prior years, current marketplace demand, upcoming ","url":"\/api-documentation?category=seller#ep-seller-get_market_insights"},{"category":"seller","method":"get_market_notification_rank","summary":"Returns the acting seller's location-follow notification status for one location. There is no notification priority queue; the position field remains empty for compatibility.","url":"\/api-documentation?category=seller#ep-seller-get_market_notification_rank"},{"category":"seller","method":"get_market_notifications","summary":"Compatibility view of the acting seller's followed venues grouped by continent and city. Follow state and completed bid-fill history are separate signals. Manage follows with \/v1\/location\/set_follow.","url":"\/api-documentation?category=seller#ep-seller-get_market_notifications"},{"category":"seller","method":"get_onboarding_location_options","summary":"Searches venues for the seller onboarding followed venues selector. Public-by-design: prospective sellers can search venues before signing in.","url":"\/api-documentation?category=seller#ep-seller-get_onboarding_location_options"},{"category":"seller","method":"get_onboarding_profile","summary":"Returns selected venue stats, related venues, and sponsor matches for seller onboarding. Public-by-design: prospective sellers need to understand their opportunity before signing in.","url":"\/api-documentation?category=seller#ep-seller-get_onboarding_profile"},{"category":"seller","method":"get_onboarding_teammate_invite_link","summary":"Builds a personal teammate invite link for a related venue.","url":"\/api-documentation?category=seller#ep-seller-get_onboarding_teammate_invite_link"},{"category":"seller","method":"get_performance_dashboard","summary":"Returns seller-private CRM and performance intelligence for the acting user.","url":"\/api-documentation?category=seller#ep-seller-get_performance_dashboard"},{"category":"seller","method":"get_recent_sales","summary":"Returns one lazy-load page from the acting seller's recent sales ledger. The maximum result window is restricted to 25, 50, or 100. Each request returns at most 25 rows. Web callers may request shared server-rendered fra","url":"\/api-documentation?category=seller#ep-seller-get_recent_sales"},{"category":"seller","method":"get_reward_list","summary":"Returns active seller rewards. The held filter includes the authenticated seller's submitted answers independently of public discovery. Rows include appointmentStatus, appointmentUUID, submittedAt, and an owner-only subm","url":"\/api-documentation?category=seller#ep-seller-get_reward_list"},{"category":"seller","method":"get_sponsorships","summary":"Returns sponsorship status for the acting seller.","url":"\/api-documentation?category=seller#ep-seller-get_sponsorships"},{"category":"seller","method":"get_supply_assessment","summary":"Returns a four-state supply assessment for listing-creation guardrails. Use this before creating new supply to see whether a venue or exact inventory slot has room_for_supply, good_supply, oversupply, or no_estimation. T","url":"\/api-documentation?category=seller#ep-seller-get_supply_assessment"},{"category":"seller","method":"get_traderpoint_event_gaps","summary":"Returns paginated event-gap cities for the acting seller's matched markets.","url":"\/api-documentation?category=seller#ep-seller-get_traderpoint_event_gaps"},{"category":"seller","method":"get_traderpoint_leadership_opportunities","summary":"Returns community leadership opportunities for the acting seller's matched markets.","url":"\/api-documentation?category=seller#ep-seller-get_traderpoint_leadership_opportunities"},{"category":"seller","method":"get_traderpoint_overview","summary":"Returns the lightweight Earn Traderpoints workbench overview for the acting seller. The payload includes account balance, spam-rate status, Market Insights pricing, new-location reward status, and route destinations. Hea","url":"\/api-documentation?category=seller#ep-seller-get_traderpoint_overview"},{"category":"seller","method":"get_work_queue","summary":"Returns seller drafts, listings, submissions, active held or shortlisted bids, reviews, and transfer tasks.","url":"\/api-documentation?category=seller#ep-seller-get_work_queue"},{"category":"seller","method":"set_close_sponsorship_request","summary":"Closes the acting seller's pending sponsor request for the selected medal.","url":"\/api-documentation?category=seller#ep-seller-set_close_sponsorship_request"},{"category":"seller","method":"set_onboarding_sponsor_request","summary":"Requests a seller onboarding sponsor, replacing the acting user's pending request when needed.","url":"\/api-documentation?category=seller#ep-seller-set_onboarding_sponsor_request"},{"category":"seller","method":"set_onboarding_sponsor_request_cancel","summary":"Cancels the acting seller's pending onboarding sponsor request.","url":"\/api-documentation?category=seller#ep-seller-set_onboarding_sponsor_request_cancel"},{"category":"seller","method":"set_request_sponsor_switch","summary":"Opens or reopens the acting seller's sponsor-change request chat for an approved sponsorship.","url":"\/api-documentation?category=seller#ep-seller-set_request_sponsor_switch"},{"category":"seller","method":"set_sponsorship_note","summary":"Saves the acting sponsor's public concierges sponsorship message.","url":"\/api-documentation?category=seller#ep-seller-set_sponsorship_note"},{"category":"sidebar","method":"get_plans_render","summary":"Returns only the server-rendered \"My Bookings\" block plus the matching plans state. Used by the v2 shell to defer the expensive city-grouped travel-plans fetch until after the initial page render. Auth: plans are persona","url":"\/api-documentation?category=sidebar#ep-sidebar-get_plans_render"},{"category":"sidebar","method":"get_render","summary":"Returns server-canonical rendered HTML for the v2 sidebar plus the matching state struct. The client's contract is to replace the inner HTML of the sidebar aside element with Payload.html and update window.ATV2ShellState","url":"\/api-documentation?category=sidebar#ep-sidebar-get_render"},{"category":"sidebar","method":"get_state","summary":"Returns the current state of the v2 sidebar \u2014 the same struct that is embedded in window.ATV2ShellState.sidebar at SSR time. Use this when the client needs to re-derive its in-memory model without re-parsing the rendered","url":"\/api-documentation?category=sidebar#ep-sidebar-get_state"},{"category":"sidebar","method":"set_communities_view","summary":"Persist the personal community list sort without changing My Bookings. Authenticated users only; writes the sidebar preference cookie.","url":"\/api-documentation?category=sidebar#ep-sidebar-set_communities_view"},{"category":"sidebar","method":"set_expanded","summary":"Toggle the expand\/collapse state of a top-level submenu and persist the choice to the user's `atv2_sidebar_expanded` cookie. Returns the post-mutation {html, state} so the client can swap the rendered nav block. The cook","url":"\/api-documentation?category=sidebar#ep-sidebar-set_expanded"},{"category":"sidebar","method":"set_plans_view","summary":"Persist the user's preferred sort mode for the v2 sidebar's \"Your Plans\" block (city-grouped appointments). The choice is written to the `atv2_sidebar_plans_view` cookie so subsequent SSR renders pick it up; the response","url":"\/api-documentation?category=sidebar#ep-sidebar-set_plans_view"},{"category":"tools","method":"get_convert_currency","summary":"Converts a currency amount Attention: DO NOT USE for moneteray transactions, values are approximate!","url":"\/api-documentation?category=tools#ep-tools-get_convert_currency"},{"category":"tools","method":"get_geoip_data","summary":"Returns local GeoLite City data for an IPv4 or IPv6 address. Public-by-design: IP geolocation utility; it does not expose user account or session data.","url":"\/api-documentation?category=tools#ep-tools-get_geoip_data"},{"category":"trusted_client","method":"get_home","summary":"Return the signed-in user's Trusted Client home. Pending interview requests or account-linked interest take precedence and return benefits, stage-specific status and an existing request chat only. Otherwise requires Trus","url":"\/api-documentation?category=trusted_client#ep-trusted_client-get_home"},{"category":"trusted_client","method":"get_invite_preview","summary":"Preview safe Trusted Client invite terms and status for a code. Public-by-design: invite entry needs to show whether a code is usable before checkout; the payload excludes recipient identity and commission terms.","url":"\/api-documentation?category=trusted_client#ep-trusted_client-get_invite_preview"},{"category":"trusted_client","method":"get_invites","summary":"Return the authenticated user's Trusted Client invite-code management summary.","url":"\/api-documentation?category=trusted_client#ep-trusted_client-get_invites"},{"category":"trusted_client","method":"set_claim_invite_code","summary":"Claim a Trusted Client invite code for the signed-in user, or return a sign-in preview for a guest. Public-by-design: logged-out code entry must show the same safe terms and sign-in action without mutating the invite.","url":"\/api-documentation?category=trusted_client#ep-trusted_client-set_claim_invite_code"},{"category":"trusted_client","method":"set_create_invite_code","summary":"Create an unclaimed Trusted Client invite code. The signed-in person who enters the code claims it and becomes tied to the creator.","url":"\/api-documentation?category=trusted_client#ep-trusted_client-set_create_invite_code"},{"category":"trusted_client","method":"set_register_interest","summary":"Register interest in Trusted Client access for a logged-in user or guest email. Public-by-design: no-code visitors need a lightweight way to express interest without an invite.","url":"\/api-documentation?category=trusted_client#ep-trusted_client-set_register_interest"},{"category":"trusted_client","method":"set_revoke_invite_code","summary":"Revoke an unused Trusted Client invite code owned by the authenticated creator.","url":"\/api-documentation?category=trusted_client#ep-trusted_client-set_revoke_invite_code"},{"category":"user","method":"get","summary":"Searches all user aliasses","url":"\/api-documentation?category=user#ep-user-get"},{"category":"user","method":"get_address_manager","summary":"Read private saved addresses and phones. Only the owner or an AccessSpecialFunctions holder can read them. Identity documents, national identifiers and birth dates are never included. An unset legacy account phone uses t","url":"\/api-documentation?category=user#ep-user-get_address_manager"},{"category":"user","method":"get_community_verification_center","summary":"Returns the acting user's community verification center payload. This powers the native v2 account verification center. The invitee verification flow remains the existing \/verify\/{uuid} route; this endpoint only exposes ","url":"\/api-documentation?category=user#ep-user-get_community_verification_center"},{"category":"user","method":"get_details","summary":"Returns details of the acting API User. Existing authorized impersonation selects the inspected user. Callers with AccessSpecialFunctions may select a user by ID, including signups without an alias. Only on RC, callers w","url":"\/api-documentation?category=user#ep-user-get_details"},{"category":"user","method":"get_email_change","summary":"Read the original authenticated owner's latest email change, or inspect a target with AccessSpecialFunctions.","url":"\/api-documentation?category=user#ep-user-get_email_change"},{"category":"user","method":"get_evaluate_permission","summary":"Returns the current value of the requested permission","url":"\/api-documentation?category=user#ep-user-get_evaluate_permission"},{"category":"user","method":"get_profile","summary":"Returns a public profile payload for a user, suitable for rendering a profile screen or sharing externally. The response is viewer-aware: sensitive metrics (chargeback rate, vendor balances, U2U transfers, ...) are only ","url":"\/api-documentation?category=user#ep-user-get_profile"},{"category":"user","method":"get_profile_about_post_candidates","summary":"Finds public community posts that can be selected as the current user's profile\/About Me post.","url":"\/api-documentation?category=user#ep-user-get_profile_about_post_candidates"},{"category":"user","method":"get_profile_about_post_profiles","summary":"Returns the public profiles currently using a community post as their profile\/About Me post. Public-by-design: the newsfeed already exposes the aggregate profile-use count on public post cards. This endpoint only returns","url":"\/api-documentation?category=user#ep-user-get_profile_about_post_profiles"},{"category":"user","method":"get_profile_additional_metrics","summary":"Returns the expanded, non-hero metrics for a profile. Public-by-design: this mirrors the public profile metric rules unless the owner has set a visibility threshold. Sensitive metrics remain gated by the existing AccessS","url":"\/api-documentation?category=user#ep-user-get_profile_additional_metrics"},{"category":"user","method":"get_profile_medal_tracks","summary":"Returns published medal progress for the authenticated account only. No target account parameter is accepted. Progress is calculated fresh.","url":"\/api-documentation?category=user#ep-user-get_profile_medal_tracks"},{"category":"user","method":"get_profile_media_gallery","summary":"Returns image media for the public profile gallery from the selected About Me post only. Public-by-design: profile pages are public unless the owner has set a visibility threshold. Locked profiles return an authorization","url":"\/api-documentation?category=user#ep-user-get_profile_media_gallery"},{"category":"user","method":"get_profile_sales_history","summary":"Returns v2 profile sales history scoped for the acting viewer. AccessSpecialFunctions users see all buyer\/seller trades for the target user. Normal users see only trades where they were the counterparty, or all of their ","url":"\/api-documentation?category=user#ep-user-get_profile_sales_history"},{"category":"user","method":"get_profile_setup","summary":"Returns the acting user's reusable v2 profile setup onboarding payload.","url":"\/api-documentation?category=user#ep-user-get_profile_setup"},{"category":"user","method":"get_profile_setup_city_options","summary":"Searches city homebase options for the reusable profile setup insert.","url":"\/api-documentation?category=user#ep-user-get_profile_setup_city_options"},{"category":"user","method":"get_profile_setup_status","summary":"Returns the acting user's lightweight v2 profile setup status. This intentionally skips display context such as suggested users, communities, venues, verifier lists, and venue detail cards.","url":"\/api-documentation?category=user#ep-user-get_profile_setup_status"},{"category":"user","method":"get_profile_visibility_preview","summary":"Previews which public medal\/usergroup tiers can see a profile at a given importance-points threshold, including the highest-ranked verified users by total importance points.","url":"\/api-documentation?category=user#ep-user-get_profile_visibility_preview"},{"category":"user","method":"get_profile_visitors","summary":"Returns signed-in visitors for a profile. Auth: the profile owner needs Permission::SeeProfileInsights to see their own visitor identities. Administrators with Permission::AccessSpecialFunctions can inspect other profile","url":"\/api-documentation?category=user#ep-user-get_profile_visitors"},{"category":"user","method":"get_purchase_contact_options","summary":"Lists the acting buyer's completed purchases from a seller and authorized purchase conversations. Does not create, reopen or grant access to chats. Closed or unavailable chats use the authorized reservation help page.","url":"\/api-documentation?category=user#ep-user-get_purchase_contact_options"},{"category":"user","method":"get_relationship_block_list","summary":"Returns users blocked by the current viewer.","url":"\/api-documentation?category=user#ep-user-get_relationship_block_list"},{"category":"user","method":"get_relationship_controls","summary":"Returns the current viewer's block\/mute controls for a target user.","url":"\/api-documentation?category=user#ep-user-get_relationship_controls"},{"category":"user","method":"get_transaction_history","summary":"Returns transaction history for the user","url":"\/api-documentation?category=user#ep-user-get_transaction_history"},{"category":"user","method":"get_user_to_user_chat_tag_id","summary":"Returns the chat id for the user-to-user chat","url":"\/api-documentation?category=user#ep-user-get_user_to_user_chat_tag_id"},{"category":"user","method":"get_verification_invite","summary":"Returns the public invite payload for a \/verify\/{uuid} community verification link. Public-by-design: possession of the verification UUID is the invite authorization. This endpoint exposes only the target identity detail","url":"\/api-documentation?category=user#ep-user-get_verification_invite"},{"category":"user","method":"set_account_phone","summary":"Set the acting user's default phone using POST. Inheriting addresses require review of the new phone; the approved payout snapshot remains active.","url":"\/api-documentation?category=user#ep-user-set_account_phone"},{"category":"user","method":"set_address","summary":"Create or edit an address owned by the acting user using POST. Label-only changes retain review status.","url":"\/api-documentation?category=user#ep-user-set_address"},{"category":"user","method":"set_avatar","summary":"Sets the user's avatar (an emoji). Replaces the legacy \/modules\/community\/changeprofile.php flow with a v2-friendly apiv1 surface that the v2 user-profile \"MY ACCOUNT\" panel can call directly. The v1 page stays in place ","url":"\/api-documentation?category=user#ep-user-set_avatar"},{"category":"user","method":"set_bid_user_to_user_chat_request","summary":"Starts or reopens a bid customer chat after checking bid chat availability. Preserves the legacy customer-chat rule: the viewer must be the buyer or current holder of the bid, the target must be the bid counterparty. Exi","url":"\/api-documentation?category=user#ep-user-set_bid_user_to_user_chat_request"},{"category":"user","method":"set_cancel_email_change","summary":"Cancel the owner's pending change, or an explicitly selected target's change with AccessSpecialFunctions.","url":"\/api-documentation?category=user#ep-user-set_cancel_email_change"},{"category":"user","method":"set_cancel_email_change_link","summary":"Public-by-design: possession of the old mailbox's single-purpose cancellation token authorizes stopping its request only.","url":"\/api-documentation?category=user#ep-user-set_cancel_email_change_link"},{"category":"user","method":"set_community_verifiable_details","summary":"Sets the users community verifable details, each change will reset all community verifications","url":"\/api-documentation?category=user#ep-user-set_community_verifiable_details"},{"category":"user","method":"set_delete_address","summary":"Remove an owned address using POST while retaining its review history. The active payout address must first be replaced.","url":"\/api-documentation?category=user#ep-user-set_delete_address"},{"category":"user","method":"set_listing_personal_info_prefill","summary":"Saves the acting user's account-wide personal-information prefill preference for bid fills and listings. Enabled by default. Newly opened forms on every device use the saved value; existing drafts are preserved.","url":"\/api-documentation?category=user#ep-user-set_listing_personal_info_prefill"},{"category":"user","method":"set_primary_address","summary":"Explicitly select an owned approved revision for payouts using POST. Other saved addresses never change payout details automatically.","url":"\/api-documentation?category=user#ep-user-set_primary_address"},{"category":"user","method":"set_profile_about_post","summary":"Sets or clears the current user's profile\/About Me community post and optional image selections from that post's attached media.","url":"\/api-documentation?category=user#ep-user-set_profile_about_post"},{"category":"user","method":"set_profile_chat_settings","summary":"Updates whether the current user's profile accepts new low-friction chat requests. Existing marketplace-required chats and transaction\/support chats are not disabled by this setting.","url":"\/api-documentation?category=user#ep-user-set_profile_chat_settings"},{"category":"user","method":"set_profile_homebase","summary":"Saves the acting user's profile setup homebase city.","url":"\/api-documentation?category=user#ep-user-set_profile_homebase"},{"category":"user","method":"set_profile_intent","summary":"Updates the current user's profile intent. With onlyIfUnset=true, an existing preference is preserved and returned without intent-related follow changes.","url":"\/api-documentation?category=user#ep-user-set_profile_intent"},{"category":"user","method":"set_profile_setup_follows","summary":"Follows or unfollows profile setup users, boards, and locations, with the same location-follow mutation as location\/set_follow.","url":"\/api-documentation?category=user#ep-user-set_profile_setup_follows"},{"category":"user","method":"set_profile_visibility","summary":"Updates the current user's profile visibility threshold. The threshold is based on a viewer's cached total importance points. A threshold of 0 means \"Any\" and keeps the profile visible to everyone.","url":"\/api-documentation?category=user#ep-user-set_profile_visibility"},{"category":"user","method":"set_profile_visit_notifications","summary":"Updates the acting profile owner's visitor notification preferences. Requires SeeProfileInsights. Enabled with Priority delivery by default; applies to future visits.","url":"\/api-documentation?category=user#ep-user-set_profile_visit_notifications"},{"category":"user","method":"set_relationship_block","summary":"Blocks or unblocks a user for optional user-to-user contact.","url":"\/api-documentation?category=user#ep-user-set_relationship_block"},{"category":"user","method":"set_relationship_mute","summary":"Mutes or unmutes a user for viewer-side chat urgency.","url":"\/api-documentation?category=user#ep-user-set_relationship_mute"},{"category":"user","method":"set_relationship_note","summary":"Saves or clears the current viewer's private note about a target user. The note is private to the current viewer and is not shown to the target user.","url":"\/api-documentation?category=user#ep-user-set_relationship_note"},{"category":"user","method":"set_request_email_change","summary":"Request a protected email change for the original owner, or an explicit target with AccessSpecialFunctions. Sends old-address cancellation and new-address verification emails; never changes the login email immediately. S","url":"\/api-documentation?category=user#ep-user-set_request_email_change"},{"category":"user","method":"set_submit_address_verification","summary":"Submit an owned address revision and its effective phone through the existing document review. Use POST for personal information.","url":"\/api-documentation?category=user#ep-user-set_submit_address_verification"},{"category":"user","method":"set_user_to_user_chat_decision","summary":"Accepts or denies a user-to-user profile chat request. The requested user may also accept a previously denied request.","url":"\/api-documentation?category=user#ep-user-set_user_to_user_chat_decision"},{"category":"user","method":"set_user_to_user_chat_request","summary":"Starts or reopens a user-to-user profile chat request. If the existing marketplace chat permission already allows the pair, the chat is immediately sendable. Otherwise the target user receives an in-chat request decision","url":"\/api-documentation?category=user#ep-user-set_user_to_user_chat_request"},{"category":"user","method":"set_verify","summary":"Verifies another user. A newly saved positive confirmation joins their Inner Circle and queues a high-priority notification to them linking to the confirming user's profile.","url":"\/api-documentation?category=user#ep-user-set_verify"},{"category":"user","method":"set_verify_email_change","summary":"Public-by-design: possession of the proposed mailbox's token verifies that address only; never grants login or early completion.","url":"\/api-documentation?category=user#ep-user-set_verify_email_change"}],"categories":[{"name":"account","description":"Manages Access to the AppointmentTrader Account","count":4,"url":"\/api-documentation?category=account"},{"name":"aichat","description":"Manages AI Chat related functions","count":4,"url":"\/api-documentation?category=aichat"},{"name":"appsv2","description":"V2 appstore - list, create, configure, and purchase iframe-hosted apps.\n\nDistinct from \/v1\/apps\/ (the legacy `\\AT\\ATApps` dev-platform model for\nexternally-hosted developer apps with private keys). The `appsv2`\nnamespace covers the v2 iframe app shell (\\AT\\ATAppsV2,\n\/modules\/v2\/_app_host\/), backed by the `ATAppsV2` table for user-created\nentries plus the static manifests in \/config\/atv2-apps.php for first-party\nshells.","count":7,"url":"\/api-documentation?category=appsv2"},{"name":"auction","description":"","count":6,"url":"\/api-documentation?category=auction"},{"name":"auth","description":"Auth session management endpoints for native v2 account surfaces.\n\nEmail-code and Google-state initiation are public by design. Session-management\nendpoints are authenticated-only. They expose the viewer's active\nbrowser sessions, allow a user to remove one session, remove every other\nsession, or remove all sessions. Removing the current browser session\nclears the current browser session cookie and returns signedOut=true so native v2 clients\ncan hard-navigate into the logged-out shell.","count":6,"url":"\/api-documentation?category=auth"},{"name":"beta_program","description":"Beta Program invite-code endpoints.\n\nAuth: every endpoint requires an authenticated user ($_APIUserID > 0).","count":5,"url":"\/api-documentation?category=beta_program"},{"name":"bid","description":"Manages all bid related functions","count":14,"url":"\/api-documentation?category=bid"},{"name":"bidauction","description":"","count":3,"url":"\/api-documentation?category=bidauction"},{"name":"bidpool","description":"Private responses during collection, with a signed-in decision comparison after selection.","count":6,"url":"\/api-documentation?category=bidpool"},{"name":"bookmarks","description":"V2 user bookmarks \u2014 list \/ add \/ remove \/ reorder.\n\nBookmarks here are arbitrary destinations the user has chosen to save: a\nforum thread, a location market page, a user profile, a specific listing.\nEach row carries its own title + url + description, persisted per-user in\n`ATUserBookmarks` (added in 000002 migration). V2 newsfeed post URLs also\ncache `Cache-ATDiscussionPosts_ID` for indexed post bookmark counts.\n\nThis replaces the earlier sidebar-pin model (set_pin \/ set_reorder on\n\/v1\/sidebar\/) where bookmarks were registry-key references \u2014 keeping a\npinned copy of an item that already lived in the main nav was redundant\nby design and showed up as duplicate rows in the sidebar.\n\nAuth: every endpoint requires an authenticated user ($_APIUserID > 0).\nThe library layer (\\AT\\ATV2Bookmarks) enforces ownership on every read\nand write so a stolen\/forged bookmark id never lets one user touch\nanother's row.","count":4,"url":"\/api-documentation?category=bookmarks"},{"name":"checkout","description":"","count":4,"url":"\/api-documentation?category=checkout"},{"name":"community","description":"Manages Community Related Functions","count":91,"url":"\/api-documentation?category=community"},{"name":"concierge","description":"Powers the v2 Intent Composer (templates\/v2\/_composer\/intent.html) by\nexposing the concierge-pipeline endpoints via the apiv1 surface.\n\nMost methods here are thin passthroughs to legacy \/API\/...php endpoints\n(or a single legacy library call). Pricing and seller-matching logic\nstays owned by the legacy code path so \/modules\/concierge\/ keeps working.\n\nException: get_categorize_request was forked off the\n\/API\/categorize_request.php logic in 2026-04 to add intent-aware,\nchecklist-driven multi-step parsing for buy \/ sell \/ socialize. The\nlegacy file still serves the v1 portal - we copied its behavior here so\nwe can rework the response shape without touching it. See\nlibraries\/concierge\/intent_definitions.php for the per-intent step\nconfig.","count":35,"url":"\/api-documentation?category=concierge"},{"name":"customer_survey","description":"Seller-private customer surveys with customer-confirmed answer reuse.","count":13,"url":"\/api-documentation?category=customer_survey"},{"name":"discovery","description":"Public place discovery and indicative reservation pricing for agents. No account actions.","count":5,"url":"\/api-documentation?category=discovery"},{"name":"documentation","description":"Search the AppointmentTrader API reference.","count":1,"url":"\/api-documentation?category=documentation"},{"name":"event","description":"Signed developer webhooks, subscriptions and 90-day delivery history. Restricted developer access is required.","count":12,"url":"\/api-documentation?category=event"},{"name":"events","description":"Endpoints for real-world event entities (F1 races, conventions, big concerts,\nfashion weeks, etc.) ranked globally and surfaced in Market Data and via","count":17,"url":"\/api-documentation?category=events"},{"name":"external_messaging","description":"External Messaging\n\nChannel-neutral outbound messaging control plane. Phase one supports email,\nwith shared identities, billing, events, suppressions, and delivery health\ndesigned for future channels such as SMS or WhatsApp.","count":14,"url":"\/api-documentation?category=external_messaging"},{"name":"floorplan","description":"Community-built floorplan layer.\n\nA floorplan is a venue\/event interior map (`ATFloorplans` ->\n`ATFloorplanFloors` -> `ATFloorplanLayouts` -> `ATFloorplanAreas`).\nCommunity members draw the walls and furniture in-browser; the resulting\nareas can be tagged on `ATLocation.ATFloorplanArea_ID` or\n`ATLocationEvents.ATFloorplanArea_ID`, and trades that settle against\ntagged venues pay the floorplan creator a royalty (handled in\n`events\/ontransactionstatechange\/commission.php`).\n\nArchitecture vs. furniture: each floor stores an `ArchitectureSVG` text\nblob for the bits that don't change (walls, columns, restrooms) and one\nor more `ATFloorplanLayouts` rows for the bits that DO (tables, sections,\npatio seating). Exactly one layout per floor is `Status='Active'` at any\ngiven moment; older Active layouts flip to `Historical` when a new one\ngoes live, so attribution still resolves for past appointments.\n\nComposer integration is intentionally deferred to a follow-up; v1 ships\nwith a direct creation entry point (`set_new`) callable from the gallery\npage or any other surface. Every new floorplan links directly to an\n`ATLocation_ID`, an `ATLocationEvent_ID`, or both.\n\nAuth: `set_*` writes require `Permission::CanCreateFloorplan`,\nownership, or `Permission::CanReviewFloorplanSubmissions` depending on\nthe action. Reads of an Active floorplan are public so consuming\nsurfaces can render it without auth.","count":17,"url":"\/api-documentation?category=floorplan"},{"name":"infractions","description":"Private user-infraction reporting, staff adjudication and bounty administration.","count":6,"url":"\/api-documentation?category=infractions"},{"name":"listing","description":"Manages portfolio related functions such as price changes and status changes","count":20,"url":"\/api-documentation?category=listing"},{"name":"location","description":"Handles all location related functions.","count":24,"url":"\/api-documentation?category=location"},{"name":"marketdata","description":"Contains all market data related functions to allow sellers to pick up on trends throughout the year","count":14,"url":"\/api-documentation?category=marketdata"},{"name":"medal","description":"Manages All Medal and User Permission Related Functions","count":4,"url":"\/api-documentation?category=medal"},{"name":"media","description":"The signed-in account's private lifetime media library and reusable picker.","count":15,"url":"\/api-documentation?category=media"},{"name":"notification","description":"Manages all notification related functions","count":12,"url":"\/api-documentation?category=notification"},{"name":"partner","description":"","count":24,"url":"\/api-documentation?category=partner"},{"name":"portfolio","description":"Manages all portfolio related functions","count":25,"url":"\/api-documentation?category=portfolio"},{"name":"reservation","description":"Native v2 reservation detail, share, and review endpoints.","count":8,"url":"\/api-documentation?category=reservation"},{"name":"seller","description":"Seller dashboard aggregate endpoints.","count":25,"url":"\/api-documentation?category=seller"},{"name":"sidebar","description":"V2 sidebar \u2014 runtime read\/render endpoints.\n\nThe sidebar markup is owned by `\\AT\\ATV2Sidebar` (declarative registry at\n\/config\/atv2-sidebar.php \u2192 \/libraries\/atv2-sidebar.lib.php) and rendered\nserver-side once per page load. After the initial render the client may\nmutate sidebar-relevant state (pin\/unpin, expand\/collapse a submenu,\nchange the plans sort\/group). These endpoints are how the client gets a\nfresh, server-canonical render after such a mutation \u2014 so layout never\ndrifts between client and server, and the client never re-implements the\nmarkup.\n\nThe complementary mutation endpoints are set_expanded (submenu collapse\nstate) and set_plans_view (plans-block sort). Per-user bookmarks moved\nto \/v1\/bookmarks\/* \u2014 they're no longer references to sidebar registry\nitems but full {title, url, description} rows owned by the user.\n\nAuth: all endpoints accept anonymous callers and degrade gracefully (no\nplans block). The viewer's user id is taken from the apiv1 dispatcher's\nsession resolution \u2014 no explicit auth params.","count":6,"url":"\/api-documentation?category=sidebar"},{"name":"tools","description":"Provides helpful functions to compliment appointment trades","count":2,"url":"\/api-documentation?category=tools"},{"name":"trusted_client","description":"Trusted Client member-home and invite-code endpoints.","count":7,"url":"\/api-documentation?category=trusted_client"},{"name":"user","description":"Contains all user related functions","count":50,"url":"\/api-documentation?category=user"}],"version":"api-docs-74b2b6ff166d0527f0633ae3aac128258c6f2175749f2f1dc43b3c64066249c6","maxAge":3600}}