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 can use the project.update function from the @busy-hour/node package. The function take an object with the following properties:

Property	Type	Description
projectId	string	The ID of the project
name	string	The name of the project
description	string (optional)	The description of the project

Quick Example

src/main.ts

import { BusyHourNode } from '@busy-hour/node';

// Create an instance of BusyHourNode with your API key (Master/Project)
const nodeSdk = new BusyHourNode({
  apiToken: 'your-api-token',
});

nodeSdk.project.update({
  projectId: 'your-project-id',
  payload: {
    name: 'My Project',
    description: 'This is my project',
  },
});