These docs are for v1.5. Click to read the latest docs for v3.0.

Create a new lead

Create a new lead associated with an agency and a property.

Note on lead statuses
Note that leads in the Orbirental sphere can have multiple statuses (from NEW to ARCHIVED). A booking is essentially a converted lead with a status starting by BOOKED_. Many of those statuses are used by the system and are not settable when creating new lead, nor editable. When creating a lead, developers can only set statuses as one of the following options:

  • NEW: this status typically represents a booking inquiry
  • BLOCKED: this status represent a range of time at which the property is not available for booking
  • BOOKED: this status represents a booking
  • PAID_IN_FULL: this status represents a booking that has already been fully paid (typically used when adding a booking where payment is made on another platform, like for AirBnB)
Language
Click Try It! to start a request and see the response here!