Visitor Access Code Creation

This API provides visitor access code valid for a duration within next seven days and supports automated delivery via SMS or email. This api is an automation of Visitor Access Code function of Rently Manager portal

Request: POST secure.rently.com/api/v2/visitors/access_codes

(Note: Property identification requires at least one of tag_id or serial. When both are supplied, tag_id takes priority.)

Security Header

Once you get the access_token pass authorization header back to all subsequent requests

  • Name: Authorization
  • Value: Bearer 3d48f9ccf28d47619d323ff7e4d96a59d1ac34eaf9d859c592a44cff1fb49d33

Body

visitor_name - Full name of the visitor who will use the access code.

visitor_phone - Contact phone number for the visitor. Accepts E.164 or common US formats.

visitor_email - Contact email address for the visitor.

customer_visitor_id - Opaque identifier from your system (e.g., CRM lead ID) to correlate records.

start_date - Activation date in YYYY-MM-DD format. Must be today or within the next 7 calendar days.

duration_days - Number of days code remains active (inclusive). Allowed values: 1, 2, or 3. Only Smart Hub can generate more than 1 day duration

tag_id (Optional)- Property CRM Tag. Required if serial is absent.

serial (Optional)- Property Smart Hub serial. Required if tag_id is absent.

send_email (Optional)- Set true to trigger visitor email notifications. Defaults to false.

send_sms (Optional)- Set true to trigger visitor sms notifications. Defaults to false

override_bans (Optional) - Set true to bypass the property's banned-visitor check. Defaults to false.

{
  "visitor_name": "John Smith",
  "visitor_phone": "+12125559876",
  "visitor_email": "[email protected]",
  "customer_visitor_id": "crm-lead-9981",
  "start_date": "2025-08-03",
  "duration_days": 1,
  "serial": "RH-HUB-00ABC123",
  "send_email": true,
  "send_sms": true,
  "override_bans": false
}

When send_email or send_sms is enabled, the visitor receives two separate messages:

  • A schedule confirmation is sent immediately after the request succeeds.
  • The access code is delivered in a separate message on the day of the visit (start_date).

Response

Either success or error, as shown below:

{
  "success": true,
  "customer_visitor_id": "crm-lead-9981",
  "access_code": "481620",
  "start_datetime": "2025-08-03T00:00:00Z",
  "end_datetime": "2025-08-03T23:59:59Z"
}
{
  "success": false,
  "error_message": "Property not found"
}