Web Call
Disable Web Call Application
Disable specific web call applications to render them non-operational
Disable
Details
| Description | The "Disable" Endpoint provides functionality to deactivate specific web call applications, thereby rendering them non-operational. This action effectively disables the designated bundle web call app from executing its intended functions. |
|---|---|
| HTTP Method | PATCH |
| Endpoint URL | https://platform.innocalls.com/v1/api-gateway/web-call/:id/disable |
| Authorization | To access the API endpoints, you need to authenticate using API keys and API secrets. The API supports Basic Authentication for authorization. You need to include your API ID as the username and your API secret as the password in the HTTP header when making requests. Replace API_ID with your API ID and API_SECRET with your API secret, separated by a colon (:). The value after Basic is the Base64 encoding of your API key and API secret concatenated with a colon. |
| Rate Limit | 3 requests per second |
Request Parameters
| Parameter | Description | Location | Constrains |
|---|---|---|---|
| id | The appId that obtained from the initiation process | Path | Required |
Request Example
curl --request PATCH 'https://platform.innocalls.com/api/v1/api-gateway/web-call/:id/disable' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <base64-encoded string apiId:apiSecret>'Success Response Example
A successful response is indicated by the HTTP status code 204.
Possible Errors
| Error Code | Description |
|---|---|
| 401 Unauthorized | Invalid Credential |
| 403 Forbidden | Not Enough Permissions to access the resource |
| 400 BadRequest | This error occurs due to malformed or invalid request parameters |
| 429 Too Many Requests | This occurs when requests exceed the rate limit |
| 404 Not Found | This occurs when the web call application not found |
