Font Size:

API Connector List Action plugin

Introduction

The API Connector List Action plugin is used to extends methods of executing an action on a list item, such as deleting a record using the API connector.

Get started

  1. In the Design tab, under the Actions palette, drag and drop the API Connector to the list or canvas.
  2. Click the API Connector to configure the properties.
  3. Click Apply Change and click SAVE.

Properties configuration

 

  • API Connector: Select the created API connector.

  • Select Operation: Select an operation created in the API Connector Builder. Based on the operation, configure:

    • id:
      • Available with the GET and DELETE methods. Specify the ID of the item to fetch or delete.
    • Payload:
      • Available with the POST and PUT methods. Define the structure of the API in JSON or YAML format. Can include details like authentication methods, request parameters, query parameters, or more complex schemas.

     

  • Confirmation Message: Displays a message when the operation is completed.

 

Related documentation

Created by Debanraj Last modified by Aadrian on Apr 30, 2025