SettingsRename a barrier type

Rename a barrier type

Renames a CRM barrier type identified by its GUID.

Changes the display name of a barrier; opportunities keep referencing it by BarrierID, so the new name shows everywhere at once. The active state is kept (it cannot be changed through the API). Sending the current name writes nothing.

Behaviour:

  • Idempotent.
  • Safe to retry.
  • Side effect: Updates the name (and LastModified / LastModifiedBy) and raises BarrierUpdated — only when the name differs.
  • Changes are visible to the next read immediately.

See also: GET /v1/barrier

Not yet documented: examples.

curl -X PUT "https://app3.timelog.com/your-account/api/v1/barrier" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "Id": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "John Doe"
}'
"null"
PUT
/v1/barrier
PUT
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

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.

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.
Content-Typestring
Required

The media type of the request body

Options: application/json
Idstring

GUID of the barrier to rename (BarrierRead.Id — not BarrierID). Refers to BarrierRead.Id. Look up valid values with GET /v1/barrier. Valid values come from GET /v1/barrier.

Format: uuid
Namestring

New display name. - Same as the current name — Nothing is written; still 200. - Missing, null or blank — 500 Code 102, ErrorCode 60015 "Name must be set on Barrier" (domain check, not 400).

Min length: 1 • Max length: 255
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

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.

Body

application/json
Idstring

GUID of the barrier to rename (BarrierRead.Id — not BarrierID).

Refers to BarrierRead.Id. Look up valid values with GET /v1/barrier.

Valid values come from GET /v1/barrier.

Namestring

New display name.

  • Same as the current name — Nothing is written; still 200.

  • Missing, null or blank — 500 Code 102, ErrorCode 60015 "Name must be set on Barrier" (domain check, not 400).

Responses

*Success without content: HTTP 200 with the literal JSON body null. Literal JSON null (TafSuccessResult).

Order: none

Empty result: none*