Change a project's status
Moves a project to another status (Quote … Cancelled) and sets whether time can be registered on it.
Sets the project status and its status date (today), opens or closes the project for time registration (InProgress opens, OnHold / Completed / Archived / Cancelled close, Quote / Approved follow AllowTimeTracking), and when closing (Completed, Archived, Cancelled) also completes the open milestones and moves every contract to Completed (Cancelled for Cancelled). Re-opening the project does NOT re-open contracts. Always send ProjectStatus: an omitted value is 0 = Quote. Answers 200 with null.
Use it to:
- Close a project from an ERP when the engagement ends
- Open a won quote for time registration (Approved + AllowTimeTracking, or InProgress)
Rules across fields:
- R1: AllowTimeTracking is used only with ProjectStatus 0 (Quote) or 1 (Approved).
Behaviour:
- Idempotent.
- Safe to retry. Same body → same status; the status date is reset to today and ProjectStatusChanged is raised again.
- Side effect: Saves the project status units (status date = today), writes the status (DAO.UpdateOrderStatus) and notifies running time trackers of the status change.
- Side effect: Sets OpenForTimeRegistration; on Completed / Archived / Cancelled completes open milestones and changes every open contract to Completed / Cancelled.
- On failure: The status write happens inside ChangeOrderStatus, before the project save; a failure in the save leaves the new status written.
- Changes are visible to the next read immediately.
Call first: GET /v1/project/{projectID}
See also: PUT /v1/project/{projectID}
Not yet documented: errors.
curl -X PUT "https://app3.timelog.com/your-account/api/v1/project/123/status" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"ProjectStatus": 42,
"AllowTimeTracking": true
}'
import requests
import json
url = "https://app3.timelog.com/your-account/api/v1/project/123/status"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"ProjectStatus": 42,
"AllowTimeTracking": true
}
response = requests.put(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://app3.timelog.com/your-account/api/v1/project/123/status", {
method: "PUT",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"ProjectStatus": 42,
"AllowTimeTracking": true
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"ProjectStatus": 42,
"AllowTimeTracking": true
}`)
req, err := http.NewRequest("PUT", "https://app3.timelog.com/your-account/api/v1/project/123/status", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://app3.timelog.com/your-account/api/v1/project/123/status')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Put.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"ProjectStatus": 42,
"AllowTimeTracking": true
}'
response = http.request(request)
puts response.body
"null"
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
/v1/project/{projectID}/statusTarget server for requests. Edit to use your own host.
OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp).
The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.
> Not yet documented: how to obtain a token.
> Not yet documented: token lifetime.
Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp).
The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.
> Not yet documented: how to obtain a token.
> Not yet documented: token lifetime.The project.
The media type of the request body
The new status. Omitted = 0 = Quote: the validator's NotNull cannot fail on a non-nullable enum, so an empty body moves the project to Quote.
- Not one of 0–6 — 400 "ProjectStatus must be 0 = Quote or 1 = Approved or …"
- Omitted — 0 = Quote is applied.
Allowed values:
| Value | Name | Meaning |
|---|---|---|
| 0 | Quote | Quote. Time registration open = AllowTimeTracking. |
| 1 | Approved | Approved. Time registration open = AllowTimeTracking. |
| 2 | InProgress | In progress. Time registration is opened (AllowTimeTracking ignored). |
| 3 | OnHold | On hold. Time registration is closed. |
| 4 | Completed | Completed. Time registration is closed; rejected (37969) when an MCP contract uses the system customer. |
| 5 | Archived | Archived. Time registration is closed. |
| 6 | Cancelled | Cancelled. Time registration is closed. |
Whether the project is open for time registration. Used only when ProjectStatus is Quote or Approved; every other status sets it itself. - ProjectStatus is InProgress, OnHold, Completed, Archived or Cancelled — ignored - Omitted with Quote/Approved — false — the project is closed for time registration.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp).
The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.
Not yet documented: how to obtain a token.
Not yet documented: token lifetime.
Path Parameters
The project.
Body
The new status. Omitted = 0 = Quote: the validator's NotNull cannot fail on a non-nullable enum, so an empty body moves the project to Quote.
-
Not one of 0–6 — 400 "ProjectStatus must be 0 = Quote or 1 = Approved or …"
-
Omitted — 0 = Quote is applied.
Allowed values:
| Value | Name | Meaning |
|---|---|---|
0 | Quote | Quote. Time registration open = AllowTimeTracking. |
1 | Approved | Approved. Time registration open = AllowTimeTracking. |
2 | InProgress | In progress. Time registration is opened (AllowTimeTracking ignored). |
3 | OnHold | On hold. Time registration is closed. |
4 | Completed | Completed. Time registration is closed; rejected (37969) when an MCP contract uses the system customer. |
5 | Archived | Archived. Time registration is closed. |
6 | Cancelled | Cancelled. Time registration is closed. |
0123456Whether the project is open for time registration. Used only when ProjectStatus is Quote or Approved; every other status sets it itself.
-
ProjectStatus is InProgress, OnHold, Completed, Archived or Cancelled — ignored
-
Omitted with Quote/Approved — false — the project is closed for time registration.
Responses
Success without content: HTTP 200 with the literal JSON body null. Literal JSON null.