Refresh MCP tools

MCP connectors only. No request body. A failed remote discovery still answers 200 with mcp_tool_sync.status = ERROR.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request parameters

ParameterTypeRequiredInDescription
AuthorizationstringYesHeaderPartner app token, sent raw. Bearer <token> is also accepted.
appIdstring (uuid)YesPathPartner Portal app id. Stands in for Meta's entity_id.
connectorIdstringYesPathConnector id (pfbid). Meta pfbid… id.

Example request

curl --location --request POST 'https://partner.gupshup.io/partner/app/<appId>/bizai/agent_connectors/<connectorId>/refreshMCPTools' \
  --header 'Authorization: <PARTNER_APP_TOKEN>'

Response parameters — 200

ParameterTypeDescription
idstringResource id. Meta pfbid… id.
namestringName.
descriptionstringHuman-readable description.
base_urlstringRoot URL the connector calls.
connector_protocolstringOne of: HTTP, MCP.
auth_typestringOne of: OAUTH2_CLIENT_CREDENTIALS, API_KEY, NONE.
auth_configobjectCredentials for the chosen auth_type.
user_auth_injection_configobjectWhere the consumer's own auth token is injected on outbound calls.
user_auth_injection_config.locationstringOne of: body, headers, path, query.
user_auth_injection_config.field_namestringHeader, query or body field name.
user_auth_injection_config.prefixstringText placed before the value, e.g. Bearer .
connection_statusobjectWhether the connector's credentials work.
connection_status.statusstringOne of: PENDING_OAUTH, ACTIVE, EXPIRED, ERROR.
connection_status.error_messagestringError text.
mcp_tool_syncobject / nullNull for HTTP connectors.
mcp_tool_sync.statusstringOne of: ERROR, PENDING, READY.
mcp_tool_sync.last_attempted_atintegerLast attempt, Unix seconds.
mcp_tool_sync.last_successful_atintegerLast success, Unix seconds.
mcp_tool_sync.fingerprintstringHash identifying the stored value.
mcp_tool_sync.tool_countintegerNumber of tools discovered.
mtls_configobjectClient certificate status. The private key is never returned.
mtls_config.has_certificatebooleantrue if a certificate is stored.
mtls_config.fingerprintstringHash identifying the stored value.
mtls_config.expires_atintegerExpiry, Unix seconds.
mtls_config.subjectstringCertificate subject.
mtls_config.client_certificatestringStored client certificate, PEM.
mtls_config.ca_certificatestringStored CA chain, PEM.

Example response — 200 OK

{
  "id": "pfbid0McpConnectorExampleId",
  "name": "Order MCP Server",
  "description": "Connects to Shopify API for managing customer orders and inventory",
  "base_url": "https://mcp.example.com",
  "connector_protocol": "MCP",
  "auth_type": "NONE",
  "auth_config": {},
  "connection_status": {
    "status": "ACTIVE"
  },
  "mcp_tool_sync": {
    "status": "READY",
    "last_attempted_at": 1789630852,
    "last_successful_at": 1789630852,
    "fingerprint": "sha256:9ab01c77",
    "tool_count": 4
  },
  "mtls_config": {
    "has_certificate": false
  }
}

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"
}
Path Params
uuid
required

Partner Portal app id. Stands in for Meta's entity_id.

string
required
^pfbid

Connector id (pfbid).

Responses

429

Per-app rate limit exceeded. Retry after the 60-second window.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json