API Request

​

How it Works

• Send caller data such as names, phone numbers, emails, or custom variables to another system
• Retrieve information like order status, appointment availability, or account details
• Trigger automations in tools like Zapier, Make, Slack, or internal APIs
• Execute webhooks during or after a call

​

How to Use it

1. Open your Flow Editor.
2. Locate the point in the flow where the API interaction should occur.
3. Click the ➕ (plus) icon beneath or beside an existing block.
4. Under Actions, select API Request.

​

Setup

​

Option 1: Import from cURL

1. Paste the full cURL command into the cURL Command field.
2. Click Import from cURL. Phonely automatically extracts the method, endpoint, headers, and body.

curl -X POST "https://jsonplaceholder.typicode.com/posts" \
-H "Content-Type: application/json" \
-d '{
  "title": "Phonely Flow Test",
  "body": "This is a test API request from my Phonely flow.",
  "userId": 1
}'

​

Option 2: Build Manually

​

Configuration

1

API Method

Select the type of request from the dropdown:

• GET – Retrieve data from a system.
• POST – Send new data.
• PUT or PATCH– Update an existing record.
• DELETE – Remove a resource.

Example: Choose POST when sending call data to an external app.

2

API URL

Enter the endpoint where the request should go. This is the destination for your data.

3

Headers

Headers define metadata or authentication details for your API call. Click + Add to add key-value pairs such as:Select the type of request from the dropdown:

• GET – Retrieve data from a system.
• POST – Send new data (most common).
• PUT or PATCH – Update an existing record.
• DELETE – Remove a resource.

Example: Choose POST when sending call data to an external app.

Always include Content-Type: application/json for JSON-based APIs.

4

Query Parameters

Use this if your API uses query strings in the URL (e.g., filtering or pagination).

5

Body (For POST, PUT, PATCH Requests)

For POST, PUT, or PATCH requests, you can define a request body. Phonely supports multiple body types, selectable directly in the UI.Enter the endpoint where the request should go. This is the destination for your data.

​

Supported Body Types

None
Use this when the request does not require a body.Headers define metadata or authentication details for your API call. Click + Add to add key-value pairs such as:x-www-form-urlencoded
Use this when the API expects traditional form data. Each key-value pair is sent as form data, commonly required by legacy systems or OAuth flows.JSON
Use this when sending structured data in JSON format (most modern APIs).
You can switch the editor to Code mode to write raw JSON directly.

You can make your API requests dynamic by inserting variables captured earlier in your flow. Type @to open the variable picker or select from available variables or auto-gather variables to include dynamic data in your request.

6

Advanced settings

Click to expand this section. These options help control the flow behavior during API communication.Example:

Setting	Description
Enable Error Handling	Lets you catch failed API calls and redirect the flow.
Retry on Failure	Retries automatically if the server doesn’t respond.
Interim Message	Sends a short message to the caller (e.g., “Please hold while I send your request.”).
Post Interim Message Delay	Adds a short pause after the interim message.
Call Outcome Tagging	Add labels for analytics or call reports (e.g., “api_success” or “crm_update”).

Click Continue to save and move on to the Test step.

​

Test Stage

1. Click Test.
   Phonely will send the request exactly as you configured.
2. The response will display instantly, showing whether it succeeded or failed.

Status: 201 Created

​

Use cases for API Requests