About Try it

Learn how to effectively use the Try it feature in the Property API documentation.

Use the Try it feature to send sample requests to API endpoints directly from the developer portal. In the Mock (schema only) environment, Try it returns schema-driven mock responses or pre-built example responses. In the Production environment, it sends the request to the live API and returns dynamic responses from your selected test property.

Environment

You can select between two different environments (top right corner in the UI):

Mock (schema only) (default):

Helps to understand the response data schema
Recommended for all write operations (POST, PUT, DELETE)
Environment for testing without affecting live/test data

Test live endpoint:

Make sure to use only test properties.
Changes will affect your test property data
Requires valid credentials
Same API structure as production