Hide listing
curl --request POST \
--url https://api.example.com/api/v1/current-home/me/hideimport requests
url = "https://api.example.com/api/v1/current-home/me/hide"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/v1/current-home/me/hide', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/current-home/me/hide",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/current-home/me/hide"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/current-home/me/hide")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/current-home/me/hide")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyCurrent Home
Hide listing
Switch the caller’s LIVE listing to HIDDEN (paused — no new matches).
POST
/
api
/
v1
/
current-home
/
me
/
hide
Hide listing
curl --request POST \
--url https://api.example.com/api/v1/current-home/me/hideimport requests
url = "https://api.example.com/api/v1/current-home/me/hide"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/v1/current-home/me/hide', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/current-home/me/hide",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/current-home/me/hide"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/current-home/me/hide")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/current-home/me/hide")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyOverview
Sets the caller’s listingstatus from LIVE to HIDDEN. A hidden listing is excluded from match candidate generation and does not appear in other users’ match feeds, but is preserved in the database and any existing matches/conversations remain intact.
Only LIVE listings can be hidden. Calling this on a DRAFT listing (never published) or a listing that is already HIDDEN returns 409 STATE_CONFLICT — the server refuses the redundant transition rather than silently no-op’ing so the client can detect drift.
To re-list a hidden listing, call POST /current-home/me/publish. The publish eligibility gate still applies (onboarding complete + tenancy approved + at least one photo + 50..150-char description).
Authentication
Bearer <accessToken> required. Scope: user.
Path parameters
None.Query parameters
None.Request body
None.Response — 200 OK
Returns the updated Home object withstatus = HIDDEN.
{
"home": {
"id": "66400a8f1c2b4d5e6f7a8c00",
"userId": "66400a8f1c2b4d5e6f7a8b00",
"status": "HIDDEN", // enum: "DRAFT" | "LIVE" | "HIDDEN" | "DELETED"
"updatedAt": "2026-05-22T14:32:08.412Z"
// ...rest of the home shape (see GET /current-home/me)
}
}
Error responses
| Status | Code | Meaning |
|---|---|---|
| 401 | UNAUTHENTICATED | Missing, malformed, or expired access token. |
| 404 | NOT_FOUND | The user has no current_homes listing yet. |
| 409 | STATE_CONFLICT | The listing’s current status is not LIVE (e.g. it is DRAFT, HIDDEN, or DELETED). |
Example error — 409
{
"type": "https://api.swappr.co.uk/errors/state-conflict",
"title": "State conflict",
"status": 409,
"code": "STATE_CONFLICT",
"detail": "listing is DRAFT; only LIVE listings can be hidden",
"instance": "/api/v1/current-home/me/hide",
"requestId": "01HZQ7K3M4N5P6Q7R8S9T0V1W2"
}
Side effects
- Sets
current_homes.status = "HIDDEN"on the caller’s listing. updatedAtis bumped.- Hidden listings are filtered out of the match-candidate query (Phase 3 worker honours this flag).
- Enqueues a
match.recomputejob for the owner to drop stale match rows (Phase 3 worker; stub in Phase 2). - Existing matches and conversations are preserved.
See also
- Publish listing — the inverse transition.
- Get my current home
- Update my current home
curl
curl -X POST https://api.swappr.co.uk/api/v1/current-home/me/hide \
-H "Authorization: Bearer $ACCESS_TOKEN"