Request parameters
- Updated: 2025/03/12
Use the Request parameters section to add various parameters such as path and query to your requests. Ensure that the added parameters match the parameters used in the endpoint URL.
Actions
The following request parameter actions are enabled:
- Add
- Click to add a parameter.
- Edit
- In the parameters table, hover over the vertical ellipsis icon of the appropriate parameter, and click the Edit icon to edit the Parameter type, Key, Value, or Value type.
- Delete
- Delete the selected parameters.
You can delete the parameter using the delete icon in the vertical ellipsis menu of individual parameters in the Parameters table.
You can also use the Select or Select all check boxes to delete one or multiple parameters.
Parameters table
View the following parameter details in the table.
Column | Description |
---|---|
Type | Displays the type of the parameter. The parameter can be a Query parameter or a Path parameter. The package user cannot view the parameter type in the Bot editor or API Task editor. |
Key | Displays the parameter key. The package user cannot view the key in the Bot editor or API Task editor. The key is sent as part of the header. |
Value | Displays the parameter value. The package user will be able to view this value in the Bot editor or API Task editor and can update this value. |
Value is user provided | Displays the status of the value.
|
Label | Displays the parameter label for User provided values. The package user will be able to view this label for the parameter in the Bot editor or API Task editor. |
Description | Displays the parameter description. The package user will be able to view this description for the parameter in the Bot editor or API Task editor. |
Add request parameters
- Click the Request parameters tab.
- Click Add parameter or the plus (+) icon on the top of the table to add a parameter.
- In the Add parameter modal, select one of the following parameter
types:
- Query: These parameters are appended to the URL path after a ? character. For example, /accounts?user_account=company.
- Path: These parameters are directly appended to the URL path. For example, /accounts/{user_account}.
- In the Key field, enter an appropriate key name. The key name is not displayed to the package user in the Bot editor or API Task editor. This name is sent as part of the header.
- Select one of the following options:
Type Description Hard coded Enter a value that is hard-coded for the parameter. The package user will not be able to view this value in the Bot editor or API Task editor. This value is sent as part of the header. User provided - Value input type: Enable this check box if you want the input value type to be secured. When you select secured, you will be able enter the parameter through a credential, variable, or insecure string.
- Is this field mandatory?: Select No or Yes depending on the requirements of the parameter..
- Value: Enter a value. The package user will be able to view this value in the Bot editor or API Task editor and can update this value.
- Label: Enter a label for the parameter. The package user will be able to view this label for the parameter in the Bot editor or API Task editor.
- Description (optional): Enter a description for the parameter. The package user will be able to view this description for the parameter in the Bot editor or API Task editor. The description appears appear as help text in the editor.
- Click Add to add the parameter to the request.
The new parameter is displayed on the Parameters table.