Edit a project's settings

/projects/{owner}/{id}

This call allows you to change the details of the specified project. You may change:

• The project name
• The project description
• The billing group of the project

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/projects/{owner}/{id}

Request

Example request

HTTP

POST /v2/projects/rfranklin/my-project HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.govm
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

cURL

curl --data '{"name": "New project name", "description": "New project description"}' -s -H "Content-Type: application/json" -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -X POST https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/projects/RFranklin/my-project -H "Accept: application/json"

Example request body

JSON

{
    "name": "New project name",
    "description": "New project description"
}

Header Fields

Name	Description
X-SBG-Auth-Token required	Your Platform authentication token.

Path parameters

Name	Description
id	The ID of the project you are editing.
owner	The owner of the project you are editing.

Query parameters

Name	Data type	Description
fields	string	Selector specifying a subset of fields to include in the response.

Response

See a list of specific response codes that may be contained in the body of the response.