Update an external system
Replaces the name and description of an external system.
Overwrites both text fields of an existing external system; the ID, and every external key and conflict attached to it, stay as they are. Both fields are required — send the current value of the one you do not want to change.
Use it to:
- Rename your integration's system after a product rename, keeping all its external keys.
Not for:
- Renaming a system created by a built-in TimeLog integration — those integrations resolve mappings by name; keep their names unique (see ExternalSystemRead.Name).
Behaviour:
- Idempotent.
- Safe to retry.
- Side effect: Updates ExternalSystemName and ExternalSystemDescription of the row. External keys and conflicts reference the ID and are untouched.
- Changes are visible to the next read immediately.
Call first: GET /v1/external-systems/{externalSystemID}
See also: POST /v1/external-systems
Not yet documented: examples (success).
curl -X PUT "https://app3.timelog.com/your-account/api/v1/external-systems/123" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"Name": "John Doe",
"Description": "example_string"
}'
import requests
import json
url = "https://app3.timelog.com/your-account/api/v1/external-systems/123"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"Name": "John Doe",
"Description": "example_string"
}
response = requests.put(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://app3.timelog.com/your-account/api/v1/external-systems/123", {
method: "PUT",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"Name": "John Doe",
"Description": "example_string"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"Name": "John Doe",
"Description": "example_string"
}`)
req, err := http.NewRequest("PUT", "https://app3.timelog.com/your-account/api/v1/external-systems/123", 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/external-systems/123')
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 = '{
"Name": "John Doe",
"Description": "example_string"
}'
response = http.request(request)
puts response.body
{
"Properties": {
"ID": 123,
"Name": "John Doe",
"Description": "example_string",
"IsSystemExternalSystem": true
},
"Links": [
{
"Href": "example_string",
"Rel": "example_string"
}
],
"Actions": [
{}
]
}
{
"Code": 200,
"Details": [
"'Name' must not be empty.",
"'Description' must not be empty."
],
"Message": "Invalid model state error.",
"Parameters": "externalSystemUpdateModel: {"Name":null,"Description":null}",
"Url": "https://app{server-number}.timelog.com/{account}/api/v1/external-systems/1"
}
{
"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
}
{
"Code": 102,
"Details": [
{
"Message": "No external system with ExternalSystemID: 1 exist",
"ErrorCode": 37045
}
],
"Message": "Business rules exception.",
"Parameters": "externalSystemUpdateModel: null",
"Url": "https://app{server-number}.timelog.com/{account}/api/v1/external-systems/1"
}
/v1/external-systems/{externalSystemID}Target 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 external system to update.
The media type of the request body
Display name of the external system. Not unique: sending an existing name creates a second system with that name. - null, empty or whitespace-only — 400 "'Name' must not be empty." Built-in TimeLog integrations resolve key mappings by system name. Giving a system the name of another one makes those name-based lookups ambiguous (see ExternalSystemRead.Name). > Not yet documented: behaviour.
Free-text description of the external system. - null, empty or whitespace-only — 400 "'Description' must not be empty."
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 external system to update.
Body
Display name of the external system. Not unique: sending an existing name creates a second system with that name.
- null, empty or whitespace-only — 400 "'Name' must not be empty."
Built-in TimeLog integrations resolve key mappings by system name. Giving a system the name of another one makes those name-based lookups ambiguous (see ExternalSystemRead.Name).
Not yet documented: behaviour.
Free-text description of the external system.
- null, empty or whitespace-only — 400 "'Description' must not be empty."
Responses
An external system registered in the account: a named "other side" (ERP, payroll, calendar, CRM …) that TimeLog objects can be linked to through external keys (ExternalKey.ExternalSystemID) and that integration conflicts are raised against. TimeLog's own built-in integrations create one per integration handler (named after the handler, e.g. "e-conomic <site>_v1"); an integrator can register its own with POST /v1/external-systems.