Skip to main content

Updating a Project

In this section, we will show you how to update a pre-existing Busy Hour Project.

Prerequisites

  1. Busy Hour Account (Sign Up if you don't have one yet)
  2. Generate a Master/Project API Key from Dashboard/Settings or from Dashboard/Projects

Updating a Project

warning

You only can update a Busy Hour Project with any Master API Key or a Project API Key that generated specificly for the project you want to update.

To update a Busy Hour Project, you will need to use the PATCH method pointing to /v1/projects/{projectId} with the projectId is the ID of the project you want to update. The request itself accepts the following properties:

PropertyTypeDescription
namestringThe name of the project
descriptionstring (optional)The description of the project

Quick Example

curl -H "x-busy-key: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"name": "New Project Name",
"description": "New Project Description"
}' \
-X PATCH https://api.busyhour.com/v1/projects/{projectId}