Understanding how to handle write status success is crucial for ensuring that your data is correctly written to the PMS.

Understanding the Propexo API: Writing Data (Part 1)

Hi, I’m Nick, co-founder and CTO at Propexo. Today, I’ll explain how to approach writing data to our API. Our approach differs from conventional methods, so it’s crucial to understand the correct way to interact with the Propexo API.

Creating a Resident: A Step-by-Step Guide

In this example, we’ll create a resident using a Rent Manager integration. Let’s break down the process:

Initial Request

We start with a base payload containing the minimum required information for Rent Manager. Upon sending this payload, we receive an immediate 200 success response containing:

• A job ID
• A full resident payload (with null values for unspecified fields)

Tracking the Write Request

After receiving the job ID, we can track the status of our write request. When we query the write request endpoint with our job ID, we’ll see the status marked as “pending.” This indicates that:

1. We’ve successfully created a job in our system
2. The system is attempting to send the data to the PMS API
3. We’re awaiting the final response

Monitoring Status Changes

There are two ways to monitor the status of your write request:

1. Polling the endpoint until the write status changes
2. Subscribing to Propexo webhooks, which will notify you of success or failure

In our demonstration, we used the polling method and received a success response with a created record ID. This ID represents the resident’s identifier within Propexo.

Querying the Created Record

Using the created record ID, you can query the resident in Propexo to retrieve the full payload. In our example, the returned data was minimal since we provided limited initial information, but it confirms that the resident record was successfully created and is available for querying.

Next Steps

Stay tuned for our next video, where we’ll explore how to handle and interpret failed write requests.