--- updatedAt: 2026-07-13T21:23:34.000Z agentTools: projectIndex: https://apidocs.rently.com/llms.txt --- # Schedule a prebooked visit It schedules available calendar slots. n.b. If *community_type* is provided, then community_id will be considered as *partner Community ID*; otherwise, it will be treated as *Rently Community ID* # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Multifamily Availability API", "description": "Availability API", "contact": {}, "version": "1.0" }, "servers": [ { "url": "{rently_base_url}", "variables": { "rently_base_url": { "default": "secure.rently.com" } } } ], "paths": { "/api/v1/prebook/schedule_visit": { "post": { "tags": [ "Schedule Availability" ], "summary": "Schedule a prebooked visit", "description": "It schedules available calendar slots.\n\nn.b. If *community_type* is provided, then community_id will be considered as *partner Community ID*; otherwise, it will be treated as *Rently Community ID*", "operationId": "schedule_visit", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "required": [ "community_id", "visit_date", "email", "first_name", "last_name", "source" ], "type": "object", "properties": { "community_id": { "type": "string", "description": "This field accepts a single value. Either Rently community ID or Property Code (with community_type only) needs to be used as a value.", "example": "123" }, "community_type": { "type": "string", "description": "This is an optional field. example: *Yardi* / *Entrata* / *RealPage*", "example": "Yardi" }, "visit_date": { "type": "string", "description": "This field accepts the “#{YYY-MM-DD}T#{HH:MM:SS}#{Time zone}“ format. This should not be a past date/time.", "example": "2021-03-30T08:37:48-06:00" }, "email": { "type": "string", "description": "This field accepts the Email format.", "example": "john.doe@rently.com" }, "first_name": { "type": "string", "description": "Special Characters (e.g. ! # $ % ^ & * [ ]) are not allowed for this field.", "example": "John" }, "last_name": { "type": "string", "description": "Special Characters (e.g. ! # $ % ^ & * [ ]) are not allowed for this field.", "example": "Doe" }, "source": { "type": "string", "description": "Special Characters (e.g. ! # $ % ^ & * [ ]) are not allowed for this field.", "example": "Rahul" }, "phone": { "type": "string", "description": "This field accepts the Phone format.", "example": "9876543211" }, "applicant_id": { "type": "string", "description": "This field accepts the Applicant ID format.", "example": "123" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "Error - Required Params Missing": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error-RequiredParamsMissing" }, { "example": { "success": false, "message": "Required Params Missing: first_name." } } ] }, "example": { "success": false, "message": "Required Params Missing: first_name." } }, "Error - Prospect banned": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error-Prospectbanned" }, { "example": { "success": false, "message": "Prospect banned." } } ] }, "example": { "success": false, "message": "Prospect banned." } }, "Success": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Success" }, { "example": { "success": true, "message": "Booking created successfully!", "email": "john.doe@rently.com", "tour_id": "dee1edc4-5f33-5c55-67bd-ea30d206dce0" } } ] } }, "Error - Invalid Email": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error-InvalidEmail" }, { "example": { "success": false, "message": "Invalid email address." } } ] } }, "Error - Visit time already taken": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error-Visittimealreadytaken" }, { "example": { "success": false, "errors": "Visit time already taken.", "email": "john.doe@rently.com" } } ] } }, "Error - visit_date is in the past": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error-visit_dateisinthepast" }, { "example": { "success": false, "message": "visit_date '2022-03-01T08:30:00' is in the past" } } ] } }, "Error - Invalid Visit Date Format": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error-InvalidVisitDateFormat" }, { "example": { "success": false, "errors": "Invalid visit_date passed", "email": "test@rently.com" } } ] }, "example": { "success": false, "errors": "Invalid visit_date passed", "email": "test@rently.com" } }, "Error - Invalid special characters": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error-Invalidspecialcharacters" }, { "example": { "success": false, "message": "last_name should not contain special characters!" } } ] } } } } }, "deprecated": false, "security": [ { "bearer": [] } ] } } }, "components": { "schemas": { "Error-visit_dateisinthepast": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "Error-RequiredParamsMissing": { "title": "Error-RequiredParamsMissing", "required": [ "success", "message" ], "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "example": { "success": false, "message": "Required Params Missing: first_name." } }, "Success": { "title": "Success", "required": [ "success", "data", "message" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string", "nullable": true }, "message": { "type": "string" } }, "example": { "success": true, "message": "Booking created successfully!", "email": "testing1@prebookings.com", "tour_id": "e6faa5d1-d2b7-4c44-9331-03d2fcbbb08a", "redirect_url": "https://homes.rently.com/apartments-for-rent/communities/93305/preSchedule?external_booking_id=125073&info=qCOnWk7KHsO1LbwzDVM0sPSjAH8x6BxjRTVnKdrhCyrP0%252FeBxaw8IdHJ9vUj%250A53kGXsBPsvqEJldJkNy%252FBbFacfALnBYUnpkwQolpzN5DeTFWsDyRMa3ChHq5%250A8gTMpW6N%250A&schedule_time=2026%2F06%2F23+08%3A45PM&source=zillow" } }, "Error-Prospectbanned": { "title": "Error-Prospectbanned", "required": [ "success", "message" ], "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "example": { "success": false, "message": "Prospect banned." } }, "Error-Visittimealreadytaken": { "title": "Error-Visittimealreadytaken", "required": [ "success", "message" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "type": "string" }, "email": { "type": "string" } }, "example": { "success": false, "errors": "Visit time already taken.", "email": "john.doe@rently.com" } }, "Error-InvalidEmail": { "title": "Error-InvalidEmail", "required": [ "success", "message" ], "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "example": { "success": false, "message": "Invalid email address." } }, "Error-Invalidspecialcharacters": { "title": "Error-Invalidspecialcharacters", "required": [ "success", "message" ], "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "example": { "success": false, "message": "Invalid special characters." } }, "Error-InvalidVisitDateFormat": { "title": "Error-InvalidVisitDateFormat", "required": [ "success", "errors", "email" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "type": "string" }, "email": { "type": "string" } }, "example": { "success": false, "errors": "Invalid visit_date passed", "email": "test@rently.com" } } }, "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer" } } }, "security": [], "tags": [ { "name": "Schedule Availability", "description": "" } ], "x-readme": { "explorer-enabled": true, "proxy-enabled": true, "samples-enabled": true } } ```