Saved searches create — Rightmove UK

rightmove.saved_searches.create

Saved searches create

POST /v1/operations/rightmove.saved_searches.create

Headers

Authorization: Bearer YOUR_CONNECTOR_TOKEN
x-rightmove-token: YOUR_RIGHTMOVE_SSO2_TOKEN
x-idempotency-key: YOUR_UNIQUE_ATTEMPT_KEY
Content-Type: application/json

Inputs

Parameter	Example type	Example value
search	object	{"locationIdentifier":"REGION^92824","channel":"sale","radius":"1.0"}

Example input

{
  "search": {
    "locationIdentifier": "REGION^92824",
    "channel": "sale",
    "radius": "1.0"
  }
}

Open JSON schema

Input schema

{
  "$id": "https://useajar.com/schemas/rightmove/saved-searches-create.input.schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "search": {
      "additionalProperties": false,
      "properties": {
        "channel": {
          "enum": [
            "sale",
            "letting"
          ],
          "type": "string"
        },
        "dontShow": {
          "items": {
            "maxLength": 40,
            "type": "string"
          },
          "maxItems": 0,
          "type": "array"
        },
        "furnishTypes": {
          "items": {
            "maxLength": 40,
            "type": "string"
          },
          "maxItems": 0,
          "type": "array"
        },
        "includeLetAgreed": {
          "type": "boolean"
        },
        "includeSSTC": {
          "type": "boolean"
        },
        "locationIdentifier": {
          "maxLength": 100,
          "pattern": "^(REGION|OUTCODE|POSTCODE|STATION|PLACE|TOWN|CITY)\\^[A-Za-z0-9]+$",
          "type": "string"
        },
        "maxBathrooms": {
          "maximum": 10,
          "minimum": 0,
          "type": "integer"
        },
        "maxBedrooms": {
          "maximum": 10,
          "minimum": 0,
          "type": "integer"
        },
        "maxPrice": {
          "maximum": 1000000000,
          "minimum": 0,
          "type": "integer"
        },
        "minBathrooms": {
          "maximum": 10,
          "minimum": 0,
          "type": "integer"
        },
        "minBedrooms": {
          "maximum": 10,
          "minimum": 0,
          "type": "integer"
        },
        "minPrice": {
          "maximum": 1000000000,
          "minimum": 0,
          "type": "integer"
        },
        "mustHave": {
          "items": {
            "maxLength": 40,
            "type": "string"
          },
          "maxItems": 0,
          "type": "array"
        },
        "propertyTypes": {
          "items": {
            "enum": [
              "flat",
              "land",
              "detached",
              "terraced",
              "bungalow",
              "park-home",
              "semi-detached",
              "private-halls"
            ],
            "type": "string"
          },
          "maxItems": 12,
          "type": "array"
        },
        "pushNotifications": {
          "const": false
        },
        "radius": {
          "enum": [
            "0.0",
            "0.25",
            "0.5",
            "1.0",
            "3.0",
            "5.0",
            "10.0",
            "15.0",
            "20.0",
            "30.0",
            "40.0"
          ],
          "type": "string"
        },
        "tenureTypes": {
          "items": {
            "maxLength": 40,
            "type": "string"
          },
          "maxItems": 0,
          "type": "array"
        }
      },
      "required": [
        "locationIdentifier",
        "channel",
        "radius"
      ],
      "type": "object"
    }
  },
  "required": [
    "search"
  ],
  "type": "object"
}