Star or unstar a project via API

This method toggles the starred status of a project for the authenticated user. Starred projects appear at the top of the project list.

Tip: You can explore and test this endpoint interactively using our OpenAPI documentation.

URL

/projects/<project>/star

Replace <project> with either the permalink or identifier of the project.

HTTP Method

POST

Supported Parameters

None

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
-X POST \
https://test.deployhq.com/projects/my-project/star

Example Response (starring)

{
  "message": "Project has been starred!",
  "starred": true
}

Example Response (unstarring)

{
  "message": "Project has been unstarred!",
  "starred": false
}

Calling this endpoint again on an already-starred project will unstar it.