• DOCUMENTATION
  • WORKATO BLOG
  • PRODUCT BLOG
  • Return to Workato
  • Log in
  • ☰
  • Community/Discussions
Solution home App Resources HTTP

HTTP: Make REST Request Action - Request Body

Modified on: Wed, May 31, 2017 at 12:56 PM

HTTP REST Request Action - Request Body

Adding additional details to your HTTP calls

 

What is Request Body?

To have a big picture on how API works, we first must know how our API requests look like.

 

In an API call, or a HTTP request, the data is structured to different layers. Each layers coincides with different data used in different stages.


requestpacket-body.jpg



 

The Request Body, as shown as the Last layer in the diagram above, contains information that will be sent in the packet as the actual data content. The Request Body usually contains the request informations such as filters or field values for a specific object.

 

How do we know What does the API needs as the Body

Always attempt to refer back to your application's API document is your best bet. A well documented API documentation usually contains a sample call for the API endpoint. In the sample call, look out for the term


--data


This is where the data should be located in the Request body section. Here is an example of Prosperworks API : 

 

http_header.png


Understanding this, you can now easily follow the sample request, and fill in the desired details into the Request Body section. Note that Request Body are usually in JSON format. To learn more about JSON format, check it out here.

 

 

 

http_body.png



Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.

Related Articles

    Still can't find your solution?

    Visit our forums to search for answers, or post your own questions.

    Documentation
    Developer's Library
    Tutorials
    eBooks
    Product Hour
    Product Blog
    Workato Blog
    Product updates
    Customer Stories
    © Workato 2020   Privacy   Terms   +1 (844) 469-6752
    • Documentation
    • Workato Blog
    • Product Blog
    • Solutions
    • Forums
    • Tickets
    • Log in
    • Return to Workato