EditApiInfoRequest Object
Contains information about a request to edit API info.
This object is used by the following operations:
- PUT /api/apis/versions/{ApiVersionID}/info (in the request)
The properties included in the EditApiInfoRequest object are listed below.
| Property | Type | Description |
|---|---|---|
| ApiName | string | The name of the API. |
| ApiDescription | string | Description of the API. |
| ApiSummary | string | A brief, plain-text description of the API. Optional. |
| VersionName | string | Name of the API version. |
| VersionNotes | string | Notes about the API version. Optional. |
| Tags | string[ ] | One or more user-defined tags assigned to the API, separated by commas. |
| Visibility | string | The visibility setting for the API; either Public, which is visible to all users, or Limited, which is visible only to API Administrators and API Scope Group members. |
| PictureID | long | A temporary ID for a picture on the platform, such as the avatar for an app, API, or user. The PictureID is assigned by the Dropbox when the picture is first uploaded to the server, using the Dropbox service, as part of adding or updating the resource. PictureID is essentially the same as DropboxId. |
| BusinessID | string |
The unique ID for a specific business organization on the platform. The BusinessID of the parent business organization. |