Clockify - Update project

Give Feedback | Bug report

Tags: #clockify #project #create #api #rest #documentation

Author: Florent Ravenel

Last update: 2023-05-17 (Created: 2023-05-17)

Description: This notebook will show how to update a project using Clockify API from a specific workspace.

References:

Clockify API Documentation

Input

Import libraries

In [ ]:

import requests
import naas

Setup Variables

api_key: Get your API key
workspace_id: ID of the workspace
project_id: ID of the project to get
payload: data to be updated

In [ ]:

api_key = naas.secret.get("CLOCKIFY_API_KEY") or "YOUR_API_KEY"
workspace_id = "626f9e3b36c2670314c0386e" #"<WORKSPACE_ID>"
project_id = "63c7ac83978e3a0c21495757"
payload = {
    "name": "string",
    "note": "string",
    "isPublic": True,
    "archived": True,
    "billable": True,
    "clientId": "string",
    "color": "string",
    "costRate": {
        "amount": 0,
        "since": "string"
        },
    "hourlyRate": {
        "amount": 0,
        "since": "string"
        },
}

Model

Update project

In [ ]:

def update_project(api_key, workspace_id, project_id, payload):
    url = f"https://api.clockify.me/api/workspaces/{workspace_id}/projects/{project_id}"
    headers = {
        "X-Api-Key": api_key,
        "Content-Type": "application/json"
    }
    response = requests.put(url, headers=headers, json=payload)
    return response

Output

Display result

In [ ]:

response = update_project(api_key, workspace_id, project_id, payload)
if response.status_code == 200:
    print(f"✅ Project '{project_id}' update from workspace.")
else:
    print(f"❌ Error retrieving project")
response.json()