API by Pabbly

API BY PABBLY MODULE
This documentation provides a detailed, step-by-step guide on how to use the API By Pabbly Module. Following these instructions will enable you to establish a seamless connection.

1. Select "API" in the Action step:

• Within Pabbly Connect, navigate to the action step and choose "API" as the action you wish to perform. Select an action event, such as "Execute API Request".Click on the "Connect" button.
  
  

Actions:

1. "Execute API Request"

GET REQUEST (It is used to retrieve details)

• Use Case: To run any specific API request through API By Pabbly.
• Select the "Execute API Request" action, Select the request as a "GET" request. Enter your API endpoint and select Basic Auth or Bearer Token as per your API authorization.
• For e.g. Here we have taken an endpoint to get details of a specific customer in PSB through an email ID. I have selected authorization as Basic Auth. (NOTE: here email ID is entered in query parameters, which means it will be entered in the main endpoint URL itself by first entering "?").
  
  

POST REQUEST (It is used to send data to a server to create/update a resource)

• Use Case: To run any specific POST API request through API By Pabbly.
• Select the "Execute API Request" action, Select the request as a "POST" request. Enter your API endpoint and select Basic Auth or Bearer Token as per your API authorization.
• For e.g. Here we have taken an endpoint to create a customer inside Pabbly Subscription Billing through first name, last name, and email ID. I have selected authorization as Basic Auth. (NOTE: Here choose payload type as JSON and enter the required details in the "Set Parameters". You can also enter multiple parameters by clicking the "+" button).
  
  

PUT REQUEST (It is used to update the resource by API request)

• Use Case: To run any specific PUT API request through API By Pabbly.
• Select the "Execute API Request" action, Select the request as a "PUT" request. Enter your API endpoint and select Basic Auth or Bearer Token as per your API authorization.
• For e.g. Here we have taken an endpoint to update a subscriber inside Pabbly Email Marketing. I have selected authorization as Bearer Token as per the API documentation. (NOTE: Here choose payload type as JSON and enter the required details in the "Set Parameters". You can also enter multiple parameters by clicking the "+" button, Also you can get the list ID by running the "Get Subscriber list" endpoint).
  
  

PATCH REQUEST (It is used to update partial information of a resource by API request)

• Use Case: To run any specific PATCH API request through API By Pabbly.
• Select the "Execute API Request" action, Select the request as a "PATCH" request. Enter your API endpoint and select Basic Auth or Bearer Token as per your API authorization.
• For e.g. Here we have taken an endpoint to update a member inside MailChimp. I have selected authorization as a Bearer Token as per the API documentation. (NOTE: Here we have to choose custom request and then select PATCH method as this requires a custom raw JSON body to be entered. You have to add path parameters such as domain, list ID, and member ID. The original API endpoint is https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}).
  
  

DELETE REQUEST (It is used for deletion of the resource by API request)

• Use Case: To run any specific DELETE API request through API By Pabbly.
• Select the "Execute API Request" action, Select the request as a "DELETE" request. Enter your API endpoint and select Basic Auth or Bearer Token as per your API authorization.
• For e.g. Here we have taken an endpoint to delete a customer inside Pabbly Subscription Billing through the customer ID. I have selected authorization as Basic Auth as per the API documentation. (NOTE: Here the customer ID is going directly on the endpoint itself. The original endpoint is https://payments.pabbly.com/api/v1/customers/{customer_id}).
  
  

CUSTOM REQUEST (It is used to send custom Raw JSON)

• Use Case: To run any specific API request by entering custom raw JSON through API By Pabbly.
• Select the "Execute API Request" action, Select the request as a "Custom Request" request. Choose the API request, enter your API endpoint and select Basic Auth or Bearer Token as per your API authorization.
• For e.g. Here we have to choose PUT request inside Custom Request and I have taken an endpoint to update a subscriber inside Pabbly Email Marketing. I have selected authorization as a Bearer Token as per the API documentation. (NOTE: Here choose payload type as JSON and enter the required raw JSON body in the "Data" field).