ArchivePortfolio
This method can be used for the following: Archive a Portfolio.
Parameters
The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.
Headers
PUT /api/ss/portfolio/:id/archive HTTP/1.1
Host: localhost:3000
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close
Path
id (string)
Identifier for the Portfolio.
Example:
PUT /api/ss/portfolio/5e8017d2e1385f0c58e8f4f8/archive HTTP/1.1
Example
The following example is a cURL request to archive a project.
Request
Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
curl -X PUT 'https://localhost:3000/api/ss/portfolio/5e8017d2e1385f0c58e8f4f8/archive' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{}'
Response
Response contains a status.
{
"status": "Portfolio archived"
}
Last updated