PUT /apis/{apiId}
This call updates an existing API .
Request body should contain an api object which should have the fields to be updated. Only name, summary and description fields can be edited for an API.
Response contains an api object with all the details related to the created API, namely, id, name, summary, description etc.
Requires API Key as
X-Api-Keyrequest header orapikeyURL query parameter.
Servers
- https://api.getpostman.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
apiId |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
api |
Object | No | |
api.name |
String | No | |
api.description |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.