Servers Playground How we check Add a server Log in

Elron Club Public Rentals

Working · 1.4 s

club.elron/public-rentalsv0.2.0 Domain verified

Search Elron Club furnished apartments, availability, prices, details, and rental applications.

Maps & Travel

Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://elron.club/api/agent/public/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

applications.complete_document_upload

Verify the uploaded object, content signature, session ownership, expiry, and exact application version before creating the protected document record.

sessionTokenstring, required

idempotencyKeystring, required

expectedVersionstring, required

uploadSessionIdstring, required

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Elron Club Public Rentals MCP server | mcptry

Tools (25)

Tool list last changed Oct 25, 2026.

applications.complete_document_upload

Verify the uploaded object, content signature, session ownership, expiry, and exact application version before creating the protected document record.

Argument	Type	Description
sessionToken*	string
idempotencyKey*	string
expectedVersion*	string
uploadSessionId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "expectedVersion",
    "sessionToken",
    "uploadSessionId",
    "idempotencyKey"
  ],
  "properties": {
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    },
    "idempotencyKey": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "expectedVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "uploadSessionId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "additionalProperties": false
}

applications.create_document_upload

Create a 15-minute, exact-size and exact-content-type signed upload form for one email-verified application at its exact current version.

Argument	Type	Description
fileName*	string
mimeType*	string
sizeBytes*	integer
contextKey*	string
sessionToken*	string
idempotencyKey*	string
expectedVersion*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "expectedVersion",
    "contextKey",
    "fileName",
    "mimeType",
    "sizeBytes",
    "sessionToken",
    "idempotencyKey"
  ],
  "properties": {
    "fileName": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "mimeType": {
      "enum": [
        "application/pdf",
        "image/jpeg",
        "image/png"
      ],
      "type": "string"
    },
    "sizeBytes": {
      "type": "integer",
      "maximum": 10000000,
      "minimum": 1
    },
    "contextKey": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    },
    "idempotencyKey": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "expectedVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    }
  },
  "additionalProperties": false
}

applications.get_status

Read the privacy-minimized status and next actions for one scoped application session token.

read-only

Argument	Type	Description
sessionToken*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "sessionToken"
  ],
  "properties": {
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    }
  },
  "additionalProperties": false
}

applications.start

Create or reuse a duplicate-safe applicant workspace for one published rental. Requires explicit current privacy consent and an idempotency key. Email verification is sent to the applicant; the tool never returns the verification URL.

Argument	Type	Description
email*	string
phone*	string
locale	string
journey*	string
lastName*	string
rentalId*	string
firstName*	string
idempotencyKey*	string
desiredDurationMonths	any
privacyConsentVersion*

applications.submit

Submit one complete email-verified application for review using its exact version, explicit current credit-check and truth-confirmation consent, and a durable idempotency key.

Argument	Type	Description
sessionToken*	string
consentVersion*	string
idempotencyKey*	string
expectedVersion*	string
truthConfirmationAccepted*	boolean
creditCheckConsentAccepted*	boolean

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "expectedVersion",
    "creditCheckConsentAccepted",
    "truthConfirmationAccepted",
    "consentVersion",
    "sessionToken",
    "idempotencyKey"
  ],
  "properties": {
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    },
    "consentVersion": {
      "type": "string",
      "const": "2026-07-13"
    },
    "idempotencyKey": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "expectedVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "truthConfirmationAccepted": {
      "type": "boolean",
      "const": true
    },
    "creditCheckConsentAccepted": {
      "type": "boolean",
      "const": true
    }
  },
  "additionalProperties": false
}

applications.update

Update bounded applicant, tenancy, and billing data for one email-verified session using its exact current version and a durable idempotency key.

Argument	Type	Description
minorCount	any
petSummary	string
billingCity	string
billingEmail	any
sessionToken*	string
idempotencyKey*	string
tenantProfiles	array
expectedVersion*	string
tenantPartyMode	string
applicantMessage	string
billingIntentType	string

applications.upload_document

Upload one bounded PDF, JPEG, or PNG identity or company-registry document to an email-verified application using its exact version and a durable idempotency key.

Argument	Type	Description
fileName*	string
mimeType*	string
sizeBytes*	integer
contextKey*	string
sessionToken*	string
contentBase64*	string
idempotencyKey*	string
expectedVersion*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "expectedVersion",
    "contextKey",
    "fileName",
    "mimeType",
    "sizeBytes",
    "contentBase64",
    "sessionToken",
    "idempotencyKey"
  ],
  "properties": {
    "fileName": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "mimeType": {
      "enum": [
        "application/pdf",
        "image/jpeg",
        "image/png"
      ],
      "type": "string"
    },
    "sizeBytes": {
      "type": "integer",
      "maximum": 10000000,
      "minimum": 1
    },
    "contextKey": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    },
    "contentBase64": {
      "type": "string",
      "maxLength": 14000000,
      "minLength": 4
    },
    "idempotencyKey": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "expectedVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    }
  },
  "additionalProperties": false
}

bookings.get_confirmation

Return a privacy-minimized booking confirmation only after the request has converted into the authoritative Stay workflow.

read-only

Argument	Type	Description
sessionToken*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "sessionToken"
  ],
  "properties": {
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    }
  },
  "additionalProperties": false
}

contracts.get_signing_link

Return a secure signing URL only when the active signer invitation email matches the email-verified application session. Human verification, review, and signature remain in the signing flow.

read-only

Argument	Type	Description
sessionToken*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "sessionToken"
  ],
  "properties": {
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    }
  },
  "additionalProperties": false
}

help.get

Read the same approved localized article as the public website, including related answers and next steps. Historical examples never override an individual signed agreement. Returns no apartment credentials, staff notes or individual case data.

read-only

Argument	Type	Description
locale	string
articleId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "articleId"
  ],
  "properties": {
    "locale": {
      "enum": [
        "de",
        "en"
      ],
      "type": "string",
      "default": "de"
    },
    "articleId": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1
    }
  },
  "additionalProperties": false
}

help.search

Search approved general DE/EN guidance for applicants, residents and coworking guests. Returns article IDs and canonical links. Use rentals tools for current apartment availability and prices; personal tenancy details require the resident's own portal.

read-only

Argument	Type	Description
limit	integer
query	string
locale	string
offset	integer
category	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 10,
      "maximum": 30,
      "minimum": 1
    },
    "query": {
      "type": "string",
      "default": "",
      "maxLength": 200
    },
    "locale": {
      "enum": [
        "de",
        "en"
      ],
      "type": "string",
      "default": "de"
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "maximum": 1000,
      "minimum": 0
    },
    "category": {
      "enum": [
        "home",
        "building",
        "contract",
        "emergencies",
        "coworking",
        "services"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

payments.get_status

Return due and received payment truth for the scoped application. An approved human-action URL is returned only from an exact, unexpired provider session; no authorization URL is fabricated.

read-only

Argument	Type	Description
sessionToken*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "sessionToken"
  ],
  "properties": {
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    }
  },
  "additionalProperties": false
}

quotes.accept

With explicit customer confirmation, accept one exact active quote and atomically claim a 30-minute request-owned availability hold. This does not create or sign a contract and does not authorize payment.

Argument	Type	Description
quoteId*	string
sessionToken*	string
idempotencyKey*	string
acceptanceConfirmed*	boolean
expectedQuoteVersion*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "expectedQuoteVersion",
    "acceptanceConfirmed",
    "sessionToken",
    "quoteId",
    "idempotencyKey"
  ],
  "properties": {
    "quoteId": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    },
    "idempotencyKey": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "acceptanceConfirmed": {
      "type": "boolean",
      "const": true
    },
    "expectedQuoteVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    }
  },
  "additionalProperties": false
}

quotes.create

Snapshot customer-safe approved request terms into a 24-hour quote. The application must be submitted, internally approved, due-diligence positive, and solvency passed. This does not hold inventory.

Argument	Type	Description
sessionToken*	string
idempotencyKey*	string
expectedApplicationVersion*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "expectedApplicationVersion",
    "sessionToken",
    "idempotencyKey"
  ],
  "properties": {
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    },
    "idempotencyKey": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "expectedApplicationVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    }
  },
  "additionalProperties": false
}

quotes.get

Read one privacy-minimized quote and its live expiry/availability-hold state using the application session that owns it.

read-only

Argument	Type	Description
quoteId*	string
sessionToken*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "sessionToken",
    "quoteId"
  ],
  "properties": {
    "quoteId": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    }
  },
  "additionalProperties": false
}

rentals.check_availability

Check the current published availability state and earliest date for one rental. This does not create a hold or reservation.

read-only

Argument	Type	Description
locale	string
rentalId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "rentalId"
  ],
  "properties": {
    "locale": {
      "enum": [
        "de",
        "en"
      ],
      "type": "string",
      "default": "de"
    },
    "rentalId": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    }
  },
  "additionalProperties": false
}

rentals.get

Return localized customer-safe apartment details, verified availability, duration pricing, deposit, included services, terms, eligibility, media, and inquiry/application links.

read-only

Argument	Type	Description
locale	string
rentalId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "rentalId"
  ],
  "properties": {
    "locale": {
      "enum": [
        "de",
        "en"
      ],
      "type": "string",
      "default": "de"
    },
    "rentalId": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    }
  },
  "additionalProperties": false
}

rentals.get_pricing

Return current published monthly pricing by supported duration, parking, deposit, inclusions, payment method, and minimum-stay terms. Pricing is informational until a quote or hold is issued.

read-only

Argument	Type	Description
locale	string
rentalId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "rentalId"
  ],
  "properties": {
    "locale": {
      "enum": [
        "de",
        "en"
      ],
      "type": "string",
      "default": "de"
    },
    "rentalId": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    }
  },
  "additionalProperties": false
}

rentals.search

Return a compact, actionable shortlist of published furnished apartments by location, availability, capacity, rooms, duration, and monthly rent. Defaults to 10 available or upcoming rentals; call rentals.get for complete details.

read-only

Argument	Type	Description
city	string	City name; matching is case- and accent-insensitive.
limit	integer	Maximum shortlist size; inspect total and hasMore.
query	string	Free text across rental, property, city, and region names.
locale	string
region	string	Region name; common English, German, and unaccented forms are accepted.
minimumRooms	number	Minimum room count.
availableFrom	string	Latest acceptable move-in date in ISO YYYY-MM-DD; later or unverified upcoming availability is excluded.
durationMonths	any	Minimum rental duration used for price filtering.
minimumOccupancy

reservations.get_status

Read privacy-minimized hold, contract, signature, payment, reservation, or confirmation state for one application session.

read-only

Argument	Type	Description
sessionToken*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "sessionToken"
  ],
  "properties": {
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    }
  },
  "additionalProperties": false
}

viewings.get_status

Read customer-safe viewing proposals and confirmed viewing state for one email-verified application session.

read-only

Argument	Type	Description
sessionToken*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "sessionToken"
  ],
  "properties": {
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    }
  }
}

viewings.propose_availability

Propose one to five bounded future viewing slots from an email-verified application at its exact version using a durable idempotency key.

Argument	Type	Description
slots*	array
sessionToken*	string
idempotencyKey*	string
expectedVersion*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "expectedVersion",
    "slots",
    "sessionToken",
    "idempotencyKey"
  ],
  "properties": {
    "slots": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "proposedAt"
        ],
        "properties": {
          "note": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 1000
              },
              {
                "type": "null"
              }
            ]
          },
          "proposedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          }
        },
        "additionalProperties": false
      },
      "maxItems": 5,
      "minItems": 1
    },
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    },
    "idempotencyKey": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "expectedVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    }
  },
  "additionalProperties": false
}

viewings.respond_to_proposal

Accept or decline one pending Elron Club proposal with explicit confirmation, an exact application version, and a durable idempotency key. Acceptance may send the existing viewing confirmation communication.

Argument	Type	Description
action*	string
proposalId*	string
sessionToken*	string
idempotencyKey*	string
expectedVersion*	string
responseConfirmed*	boolean

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "expectedVersion",
    "action",
    "responseConfirmed",
    "sessionToken",
    "proposalId",
    "idempotencyKey"
  ],
  "properties": {
    "action": {
      "enum": [
        "ACCEPT",
        "DECLINE"
      ],
      "type": "string"
    },
    "proposalId": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    },
    "idempotencyKey": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "expectedVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "responseConfirmed": {
      "type": "boolean",
      "const": true
    }
  },
  "additionalProperties": false
}

waitlist.subscribe

Activate the newsletter immediately after the customer explicitly requests it, optionally choosing an Elron region. A new activation queues one welcome email. An explicit request may reverse a previous opt-out without a confirmation step; automated inquiry and staff flows cannot override customer opt-outs.

Argument	Type	Description
email*	string
locale	string
consent*	boolean
regionKey	string
idempotencyKey	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "email",
    "consent"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      "maxLength": 180
    },
    "locale": {
      "enum": [
        "de",
        "en"
      ],
      "type": "string",
      "default": "de"
    },
    "consent": {
      "type": "boolean",
      "const": true
    },
    "regionKey": {
      "enum": [
        "BASEL",
        "ZURICH",
        "LUZERN",
        "BERN"
      ],
      "type": "string"
    },
    "idempotencyKey": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "additionalProperties": false
}

waitlist.unsubscribe

Use an opaque unsubscribe token from an Elron marketing email to stop every waitlist marketing update.

destructive

Argument	Type	Description
token*	string
idempotencyKey	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "token"
  ],
  "properties": {
    "token": {
      "type": "string",
      "maxLength": 256,
      "minLength": 32
    },
    "idempotencyKey": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "expectedVersion",
    "sessionToken",
    "idempotencyKey"
  ],
  "properties": {
    "minorCount": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 20,
          "minimum": 0
        },
        {
          "type": "null"
        }
      ]
    },
    "petSummary": {
      "type": "string",
      "maxLength": 2000
    },
    "billingCity": {
      "type": "string",
      "maxLength": 100
    },
    "billingEmail": {
      "anyOf": [
        {
          "type": "string",
          "const": ""
        },
        {
          "type": "string",
          "format": "email",
          "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
          "maxLength": 320
        }
      ]
    },
    "sessionToken": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    },
    "idempotencyKey": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "tenantProfiles": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "isMainTenant",
          "firstName",
          "lastName",
          "birthDate",
          "identityDocumentType",
          "passportOrIdNumber",
          "phone",
          "email",
          "nationalityCode",
          "permitStatus",
          "permitDetails",
          "addressSameAsMainTenant",
          "addressLine1",
          "addressLine2",
          "postalCode",
          "city",
          "countryCode",
          "isBillingRecipient",
          "isPrimaryTenancyContact"
        ],
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1
          },
          "city": {
            "type": "string",
            "maxLength": 100
          },
          "email": {
            "anyOf": [
              {
                "type": "string",
                "const": ""
              },
              {
                "type": "string",
                "format": "email",
                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
                "maxLength": 320
              }
            ]
          },
          "phone": {
            "type": "string",
            "maxLength": 100
          },
          "lastName": {
            "type": "string",
            "maxLength": 100
          },
          "birthDate": {
            "anyOf": [
              {
                "type": "string",
                "format": "date",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "firstName": {
            "type": "string",
            "maxLength": 100
          },
          "postalCode": {
            "type": "string",
            "maxLength": 30
          },
          "countryCode": {
            "type": "string",
            "maxLength": 10
          },
          "addressLine1": {
            "type": "string",
            "maxLength": 200
          },
          "addressLine2": {
            "type": "string",
            "maxLength": 200
          },
          "isMainTenant": {
            "type": "boolean"
          },
          "permitStatus": {
            "enum": [
              "SWISS_CITIZEN",
              "EU_EFTA_CITIZEN",
              "PERMIT_B",
              "PERMIT_C",
              "PERMIT_L",
              "PERMIT_G",
              "PERMIT_CI",
              "PERMIT_F",
              "PERMIT_N",
              "PERMIT_S",
              "NO_PERMIT_YET",
              "OTHER"
            ],
            "type": "string"
          },
          "permitDetails": {
            "type": "string",
            "maxLength": 500
          },
          "nationalityCode": {
            "type": "string",
            "maxLength": 10
          },
          "isBillingRecipient": {
            "type": "boolean"
          },
          "passportOrIdNumber": {
            "type": "string",
            "maxLength": 200
          },
          "identityDocumentType": {
            "enum": [
              "PASSPORT",
              "EU_ID"
            ],
            "type": "string"
          },
          "addressSameAsMainTenant": {
            "type": "boolean"
          },
          "isPrimaryTenancyContact": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "maxItems": 10
    },
    "expectedVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "tenantPartyMode": {
      "enum": [
        "PRIVATE",
        "COMPANY"
      ],
      "type": "string"
    },
    "applicantMessage": {
      "type": "string",
      "maxLength": 10000
    },
    "billingIntentType": {
      "enum": [
        "TENANT",
        "COMPANY",
        "OTHER_PRIVATE"
      ],
      "type": "string"
    },
    "billingPostalCode": {
      "type": "string",
      "maxLength": 30
    },
    "companyTenantCity": {
      "type": "string",
      "maxLength": 100
    },
    "companyTenantName": {
      "type": "string",
      "maxLength": 500
    },
    "desiredMoveInDate": {
      "anyOf": [
        {
          "type": "string",
          "format": "date",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
        },
        {
          "type": "null"
        }
      ]
    },
    "preferredLanguage": {
      "enum": [
        "de",
        "en"
      ],
      "type": "string"
    },
    "billingCountryCode": {
      "type": "string",
      "maxLength": 10
    },
    "billingStreetLine1": {
      "type": "string",
      "maxLength": 200
    },
    "billingStreetLine2": {
      "type": "string",
      "maxLength": 200
    },
    "companyBillingName": {
      "type": "string",
      "maxLength": 500
    },
    "desiredMoveOutDate": {
      "anyOf": [
        {
          "type": "string",
          "format": "date",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
        },
        {
          "type": "null"
        }
      ]
    },
    "companyTenantSigners": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "firstName",
          "lastName",
          "roleTitle",
          "email",
          "phone"
        ],
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1
          },
          "email": {
            "anyOf": [
              {
                "type": "string",
                "const": ""
              },
              {
                "type": "string",
                "format": "email",
                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
                "maxLength": 320
              }
            ]
          },
          "phone": {
            "type": "string",
            "maxLength": 100
          },
          "lastName": {
            "type": "string",
            "maxLength": 100
          },
          "firstName": {
            "type": "string",
            "maxLength": 100
          },
          "roleTitle": {
            "type": "string",
            "maxLength": 100
          }
        },
        "additionalProperties": false
      },
      "maxItems": 10
    },
    "contractLanguageCode": {
      "enum": [
        "DE",
        "EN"
      ],
      "type": "string"
    },
    "desiredDurationMonths": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 120,
          "minimum": 1
        },
        {
          "type": "null"
        }
      ]
    },
    "employerOrCompanyName": {
      "type": "string",
      "maxLength": 500
    },
    "requestedParkingCount": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 10,
          "minimum": 0
        },
        {
          "type": "null"
        }
      ]
    },
    "billingPrivateLastName": {
      "type": "string",
      "maxLength": 100
    },
    "billingPrivateFirstName": {
      "type": "string",
      "maxLength": 100
    },
    "companyTenantPostalCode": {
      "type": "string",
      "maxLength": 30
    },
    "employmentStatusSummary": {
      "type": "string",
      "maxLength": 2000
    },
    "companyTenantCountryCode": {
      "type": "string",
      "maxLength": 10
    },
    "companyTenantStreetLine1": {
      "type": "string",
      "maxLength": 200
    },
    "companyTenantStreetLine2": {
      "type": "string",
      "maxLength": 200
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "city": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "City name; matching is case- and accent-insensitive."
    },
    "limit": {
      "type": "integer",
      "default": 10,
      "maximum": 50,
      "minimum": 1,
      "description": "Maximum shortlist size; inspect total and hasMore."
    },
    "query": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Free text across rental, property, city, and region names."
    },
    "locale": {
      "enum": [
        "de",
        "en"
      ],
      "type": "string",
      "default": "de"
    },
    "region": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Region name; common English, German, and unaccented forms are accepted."
    },
    "minimumRooms": {
      "type": "number",
      "maximum": 20,
      "minimum": 0.5,
      "description": "Minimum room count."
    },
    "availableFrom": {
      "type": "string",
      "format": "date",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
      "description": "Latest acceptable move-in date in ISO YYYY-MM-DD; later or unverified upcoming availability is excluded."
    },
    "durationMonths": {
      "anyOf": [
        {
          "type": "number",
          "const": 3
        },
        {
          "type": "number",
          "const": 6
        },
        {
          "type": "number",
          "const": 12
        }
      ],
      "description": "Minimum rental duration used for price filtering."
    },
    "minimumOccupancy": {
      "type": "integer",
      "maximum": 50,
      "minimum": 1,
      "description": "Minimum supported resident count."
    },
    "availabilityStatus": {
      "enum": [
        "AVAILABLE_OR_UPCOMING",
        "AVAILABLE",
        "UPCOMING",
        "UNAVAILABLE",
        "ANY"
      ],
      "type": "string",
      "default": "AVAILABLE_OR_UPCOMING",
      "description": "Availability scope. The default excludes unavailable inventory."
    },
    "maximumMonthlyRent": {
      "type": "number",
      "maximum": 100000,
      "description": "Maximum monthly rent in CHF for the selected duration.",
      "exclusiveMinimum": 0
    }
  },
  "additionalProperties": false
}