For the complete documentation index, see llms.txt. This page is also available as Markdown.

REST API helpers

These helpers let you connect your features to any app with an API, including your custom internal apps or apps that Ply doesn't integrate with yet

Ply has helpers that allow you to make custom API requests to send or retrieve data; this is useful when

  • You want to connect with your custom internal app

  • You want to connect with an app we haven't integrated with

  • You want to perform an action in an app that we haven't built yet

These helpers perform REST API requests – essentially, authorized messages sent between apps that send or retrieve data.

Ply's helpers

There are five helpers, each one performing a different type of request. GET and POST are the most commonly used.

  • GET: Used for retrieving data

  • POST: Used for creating an item

  • DELETE: Used for deleting an item

  • PATCH: Used for partially updating an item

  • PUT: Used for replacing all specified properties of an item

Last updated