Clockify - Add a new client

Give Feedback | Bug report

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

Author: Florent Ravenel

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

Description: This notebook will show how to add a new client 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
client_data: Data of the client to be added

In [ ]:

api_key = naas.secret.get("CLOCKIFY_API_KEY") or "YOUR_API_KEY"
workspace_id = "626f9e3b36c2670314c0386e" #"<WORKSPACE_ID>"
client_data = {
    "name": "My New Client",
    "address": None,
    "email": "[email protected]",
    "note": "My First Client"
}

Model

Create new client

This function will create a new client using Clockify API.

In [ ]:

def create_client(workspace_id, api_key, client_data):
    url = f"https://api.clockify.me/api/workspaces/{workspace_id}/clients"
    headers = {
        "X-Api-Key": api_key,
        "Content-Type": "application/json"
    }
    response = requests.post(url, headers=headers, json=client_data)
    return response

Output

Display result

In [ ]:

response = create_client(workspace_id, api_key, client_data)
if response.status_code == 201:
    print(f"✅ Client '{client_data.get('name')}' added to workspace")
else:
    print(f"❌ Error added new client")
response.json()