Custom API Action

Allows you to make a customized HTTP request to the Smartsheet API. For the most in depth information on the nature of those requests. See Smartsheet API.

Options

Field	Definition	Type	Required
Request Type	This is one of the supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods). GET: Retrieves data from a web server based on your parameters. This method requests a representation of the specified resource. If a request is successful, you receive a 200 (OK) response message with the requested content. POST: Sends data to a web server based on your parameters (for example, uploading a file). Multiple POST requests may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST requests. If a request is successful, you receive a 200 (OK) response message. PUT: Sends data to be stored at a specific location on a web server based on your parameters (for example, uploading a file). The difference between PUT and POST requests is that PUT is idempotent. This means that for successful requests, the result of a single PUT request is the same as many identical PUT requests. If a request is successful, you receive a 200 (OK), 201 (Created), or 204 (No Content) response message. PATCH: Applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, which means that multiple PATCH requests could have unintended consequences. If a PATCH is successful, you receive a 200 (OK) or 204 (No Content) response message. DELETE: Deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you receive a 200 (OK) response message.	Dropdown	TRUE

Field

Definition

Type

Required

Request Type

This is one of the supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods).

GET: Retrieves data from a web server based on your parameters. This method requests a representation of the specified resource. If a request is successful, you receive a 200 (OK) response message with the requested content.
POST: Sends data to a web server based on your parameters (for example, uploading a file). Multiple POST requests may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST requests. If a request is successful, you receive a 200 (OK) response message.
PUT: Sends data to be stored at a specific location on a web server based on your parameters (for example, uploading a file). The difference between PUT and POST requests is that PUT is idempotent. This means that for successful requests, the result of a single PUT request is the same as many identical PUT requests. If a request is successful, you receive a 200 (OK), 201 (Created), or 204 (No Content) response message.
PATCH: Applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, which means that multiple PATCH requests could have unintended consequences. If a PATCH is successful, you receive a 200 (OK) or 204 (No Content) response message.
DELETE: Deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you receive a 200 (OK) response message.

Dropdown

TRUE

Input

Field	Definition	Type	Required
Request
Relative URL	Specify the relative URL as `/api/v2/{insert_remaining_URL}`. You can specify query parameters in the relative URL using “?”, or specify the query parameters as an object key pair in the Query input. Example: https://api.smartsheet.com/2.0{{input.Request.Relative URL}}	String	FALSE
Query	Specify any additional query parameters that should be included in object format (key value pairs).	Object	FALSE
Headers	Specify any headers required in addition to authorization or content-type (these are already handled by this connector).	Object	FALSE
Body	Specify a request body in JSON format.	Object	FALSE

Output

Field	Definition	Type
Status Code	Result of your HTTP request. See HTTP status codes.	Number
Headers	Detailed context for the status code, unrelated to the output body. Response headers are dependent on your selected HTTP request option. Note that not all headers are response headers. This will be usually similar to {"Content-type":"application/json"}.	Object
Body	Data returned from your selected HTTP request (for example, the data from a `GET` request).	Object

Custom API Action

Options

Input

Output

Related topics