Create

Create and configure a new operation (API Endpoint) details.

Navigate to, Left panel --> More --> My Apps
Click the connector to be modified
In the Manage modal options, Click Create an Operation (API Endpoint)
In the Modal, modify the fields and click Save

Title - Endpoint title
Description - Endpoint description / Brief about endpoint functionality
Method - Select the endpoint action: GET, PATCH, POST, PUT, or DELETE
Path - Endpoint URL. Example /v1/contacts/create
Popular - In Designer page, True: To display it directly in the endpoints list. False, It will be displayed after clicking on show more button
Parameters - JSON editor to add the endpoint parameters



The JSON editor is the place to set the endpoint parameter(s), each parameter has a set of keys:

description - Parameter description.
label - Parameter label, it will appear instead of the parameter name (Technical name)
in - Specify the parameter location. Possible values: path, query, body , header
name - Parameter name.
required - Specify if the parameter is required. Possible values: true, false
type - Parameter type. Possible values: string, array, boolean, body, integer
default - Parameter Default value. use single quote instead of double quotes
isHidden - Specify the parameter visibility. You may need to hide a parameter if its has a fixed value (should not change) or if the parameter should be mentioned as an API Key. Possible values: true, false

Example 1: An endpoint requires parameter (name=content-type) with fixed value (default=application/json)

{
  "description": "",
  "label": "",
  "in": "header",
  "name": "content-type",
  "required": false,
  "type": "string",
  "default": "application/json",
  "isHidden": true
}

Example 2: A connector using API Key (name=X-Api-Key). Each endpoint should has this API Key so the platform will recognize it from its name. No need to add default value for it. It will read its value from connection.

{
 "description": "",
 "label": "",
 "in": "header",
 "name": "X-Api-Key",
 "required": false,
 "type": "string",
 "default": "",
 "isHidden": true
}

Code Snippet

[
  {
    "description": "YOUR_PARAMETER_DESCRIPTION",
    "label": "YOUR_PARAMETER_LABEL"
    "in": "path,query,body,header",
    "name": "YOUR_PARAMETER_NAME",
    "required": false,
    "type": "string",
    "default": "{'requests':[{'deleteDimension':{'range':{'sheetId': YOUR_SHEET_ID, 'dimension':'ROWS', 'startIndex': 0, 'endIndex': 100}}}]}",
    "isHidden": false
  }
]

Modify

Navigate to, Left panel --> More --> My Apps
Click the connector to be modified
In the Manage modal options, Click Configure Operations
In the Modal, under Operations List, Click the operation to be modified
Modify the fields and click Save

Updated on: 15/11/2022