Understanding Write actions in Propexo's API

Important to Understand

When creating or updating records through the Propexo API, it's important to understand that a successful Propexo API response (HTTP 200) doesn't necessarily mean the record was successfully processed by the Property Management System (PMS).

Verifying POST/PUT Status

To ensure a record was successfully created, follow these steps:

Make your POST or PUT request to The Propexo API

.

1. Upon receiving a successful response (HTTP 200), note the job_id in the response metadata.

2. Use the job_id to check the write operation status using the following endpoint: https://api.[sandbox].propexo.com/v1/admin/write-status/{job_id}

Interpreting Write Status Results

The write status endpoint will return one of the following statuses:

• SUCCESS: The record was successfully created in the PMS.

• FAILURE: The record creation failed. Check the errors field for more information.

• PENDING: The operation is still in progress. Check again later.

Handling Errors

If you receive a FAILURE status, common issues include:

• 403 Forbidden: This usually indicates a problem with the integration credentials. Double-check your PMS credentials and ensure they have the necessary permissions to create or update the record.

• Other error codes: Refer to the specific error message in the response for more details.

Troubleshooting Steps

1. Verify your PMS credentials are correct and have the necessary permissions.

2. For ongoing issues, reach out to Propexo support for further assistance.