In an effort to simplify our API responses and webhooks, we have updated our internal order processing to make the order_id and request_id match for orders after September 9th, 2022. Thanks to this refactor, you will no longer need to maintain two IDs for your orders, just the order_id.

When requesting PlanOmatic marketing services, providing proper property access details is an important step in setting your order up for success. When an order is placed with incorrect access details, e.g., incorrect lockbox code, our PlanOtechs will submit an appointment.unable_to_complete event, which results in a fee. One of the metrics we use to measure the health of our relationship is your Access Success Rate, which is your amount of orders that didn’t result in appointment.unable_to_complete over total orders.

Part of building a programmatic solution for your marketing assets is having a way to cancel orders that were requested by mistake. Introducing the V3 Order Cancelation API, your best way to hit the undo button after placing a mistake order.

When it comes to planning, developing, delivering and growing your integration with PlanOmatic, we understand how important it is to have a production-like environment where your team can experiment. In early 2023, we will be wrapping up our sandbox environment to provide you and your team the tools you need to grow your integration with PlanOmatic with confidence.

The PlanOmatic Integration platform (PlanOintegrate) is opening up its beta on December 1st, 2022 with its new user management and invitation features. This means you can invite your whole development team to help manage your integration!

In July 2022, the PlanOmatic V3 Order APIs became available to our clients after months of internal testing. We built this suite of APIs from the ground up to support and evolve with the needs of your company and the SFR industry. We recommend taking five minutes to check out the new features if you haven’t already.
To make sure PlanOmatic can focus on delivering and supporting the best tools to support our clients, we will be ending support of the V2 Order API in Spring 2024. While the end of support for the V2 Order API announcement may be disappointing to some clients, we are confident that you, your team and company will see the long-term benefits that come with the V3 Order APIs structure and tools.

On September 13th, 2022, PlanOmatic will be deploying our closed beta of our new integration management platform (PlanOintegrate) where clients can manage their webhook subscriptions, view and re-trigger webhook jobs.
If you or your team is interested in joining our closed beta, please fill-out this quick three question form and someone from our integration team will communicate instructions.

On August 2nd 2022, PlanOmatic will be releasing its Version 3 Order API and Webhooks. This next generation is packed with new features including photo assets sent in the webhooks body, entity organizational tools, a cancelation API, and many more features you can find in our V3 API Documentation. Along with the new features, are the under-the-hood upgrades making our API’s more reliable and built to scale to fit the needs of your growing company.
Will the Version 2 API be deprecated?
Yes, but not until spring 2024. Our plan is to start transitioning clients affected by this change early next year, with the help of custom documentation to make the transition as painless as possible.
I don’t know what version of the PlanOmatic API we are using. How do I find out the version we are using?
If you started utilizing PlanOmatic’s Order API and/or Webhooks prior to July 2022, you are most likely using our Version 2 API. The best way to check is looking at the PlanOmatic URL you are sending Order API requests to. If the URL has a /v2/ in the route, you are using version 2.

If you are reading this paragraph, welcome to PlanOmatic’s new home for API documentation and changelog! If you bookmarked and older PIanOmatic API documentation links (links prior to July 2022), you should be directed to the corresponding page on our new platform.

We have a few general optimizations we will be deploying to our webhook payload processor that introduce no notable changes for our clients.
There should be no major changes experienced on our client’s integration end. This is a small refactor to optimize our processor; however, keep an eye out for anything out of the ordinary.