post
https://partner.gupshup.io/partner/app//bizai/agent_connectors//tools//run
Makes a real outbound call to the connector's base_url. input is a JSON string, not an object.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Request parameters
| Parameter | Type | Required | In | Description |
|---|---|---|---|---|
Authorization | string | Yes | Header | Partner app token, sent raw. Bearer <token> is also accepted. |
Content-Type | string | Yes | Header | application/json |
appId | string (uuid) | Yes | Path | Partner Portal app id. Stands in for Meta's entity_id. |
connectorId | string | Yes | Path | Connector id (pfbid). Meta pfbid… id. |
toolId | string | Yes | Path | Connector tool id (pfbid). Meta pfbid… id. |
input | string | No | Body | JSON-encoded tool arguments. Defaults to {}. |
Example request
curl --location --request POST 'https://partner.gupshup.io/partner/app/<appId>/bizai/agent_connectors/<connectorId>/tools/<toolId>/run' \
--header 'Authorization: <PARTNER_APP_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"input": "{\"order_id\": \"12345\"}"
}'Response parameters — 200
200| Parameter | Type | Description |
|---|---|---|
output | string | JSON-encoded result of the outbound call. |
status | string | Status. |
Example response — 200 OK
200 OK{
"output": "{\"status\": \"shipped\", \"eta\": \"2026-09-26\"}",
"status": "success"
}Error responses
400 Bad Request — The app is not live, or WASS does not consider it live.
{
"message": "App is not live.",
"status": "error"
}400 Bad Request — The app has no phone number attached. Checked before the live check.
{
"message": "Phone id not found for the given App",
"status": "error"
}401 Unauthorized — Authorization is missing or invalid, belongs to another app, or appId is unknown or not a UUID.
{
"status": "error",
"message": "Unauthorised access to the resource. Please review request parameters and headers and retry"
}405 Method Not Allowed — Any method other than GET, POST, PUT or DELETE, e.g. PATCH.
{
"status": "error",
"message": "Request method 'PATCH' is not supported"
}429 Too Many Requests — More than 30 /bizai/** requests in 60 seconds for this app. The 31st is rejected.
{
"status": "error",
"message": "Too Many Requests"
}Per-app rate limit exceeded. Retry after the 60-second window.