Add a Request Body to a POST Request

Add a Request Body to a POST Request

Last Updated On September 04, 2019
You are here:
< Back

The API Connector add-on for Google Sheets enables requests using the GET and POST methods. GET requests are for retrieving information, while POST requests are generally used for creating or updating data.

This article describes how to add a request body to a POST request in API Connector.

CHOOSE THE POST METHOD

API Connector defaults to the GET method. To make a POST request, choose POST from the drop-down menu:
post-requests-img1

ENTER A POST BODY

As part of a POST request, a data payload can be sent to the server in the body of the request. When you select POST from the method drop-down button, the API Connector form changes to display an input field for the post body.

The body contents can be any valid JSON object, for example like this:

post-requests-img2

(OPTIONAL) SET A CONTENT-TYPE HEADER

A content-type header describes the object’s format, so the server knows how to parse it. The default content type will be application/x-www-form-urlencoded. API Connector will use this content type unless you manually set Key = content-type, Value = application/json in the Headers table, like this.

post-requests-img3

Only application/x-www-form-urlencoded and application/json content types are supported.

(OPTIONAL) ADAPT INSTRUCTIONS FOR CURL

Many services provide documentation on how to make API requests using cURL, a popular command-line tool for interacting with APIs. For example, here is some documentation from Chargebee on how to make a POST request with cURL:

post-requests-img4

In the above screenshot, the ‘-u’ flag marks the credentials that get sent in the Header, while the ‘-d’ flags mark the POST request body. To convert these instructions into a format that works with API Connector, convert all the ‘-d’ values into a JSON object, like this:

Enter the above into the POST body input field as described in the Enter a POST Body section.
post-requests-img5

TROUBLESHOOTING

• If your POST request isn’t working, a likely cause is a mismatched content type. Try adding in a content type into the header as described above, where Key = content-type, and Value = application/json.

• Try running your request with a tool like Swagger Inspector to help identify whether the issue lies with the tool settings or with the API request itself.

• Other possible issues are listed in this article on troubleshooting: Troubleshooting API Requests

• If you still have problems, please send over an email to info@mixedanalytics.com, or submit a message using the API Connector Contact Form. You’ll receive a response shortly!

Comments:3

  1. Ana, even though I appreciate having a POST option available, I don’t see how to take advantage of it considering there’s no actual integration with the google sheets content; maybe I’m missing something? Thanks.

    1. Hi Oscar, you can send a post request and the resulting response gets printed into your Google Sheet. You can also base the request URL on values in a cell. Can you please let me know what you mean by integration with the Google Sheets content? Maybe you’re referring to basing the request body on a value in a cell? That feature is coming : )

Leave a Reply

Your email address will not be published.