Knowledge Base
  • Login
Font Size:

API Endpoints

Introduction

OAS documents come with API endpoints that can be comprised of either the POST, GET, PUT and DELETE HTTP methods.

Properties configuration

POST

Parameters:

  • Name: Name of the POST API endpoint.
  • Description: A description of the POST API endpoint.
  • Request Body Input Type:
    • Payload: Request Body
    • Input Fields:
      • Field Label: Specify a field label.
      • Default Value: Specify a default value.
      • Mode:
        • Default
        • Force Mandatory
        • Hide Field

GET

Parameters:  

  • Name: Name of the GET API endpoint.
  • Description: A description of the GET API endpoint.
  • Field Label: Specify a field label.
  • Default Value: Specify a default value.
  • Mode:
    • Default
    • Force Mandatory
    • Hide Field

PUT

Parameters:  

 

  • Name: Name of the PUT API endpoint.
  • Description: A description of the PUT API endpoint.
  • Request Body Input Type:
    • Payload: Request Body
    • Input Fields:
      • Field Label: Specify a field label.
      • Default Value: Specify a default value.
      • Mode:
        • Default
        • Force Mandatory
        • Hide Field

 

SET

Parameters: 

 

  • Name: Name of the SET API endpoint.
  • Description: A description of the SET API endpoint.
  • Field Label: Specify a field label.
  • Default Value: Specify a default value.
  • Mode:
    • Default
    • Force Mandatory
    • Hide Field

 

Created by Debanraj Last modified by Gabriel on Jun 20, 2025
Tags:
Previous OAS, Design, Settings, Preview NextAPI Connector Form Load plugin