Change the name
PUThttps://api.getwerk.ai/api/v1/account/name
Sets the key's person's name, which everyone in their projects sees.
Nobody else can change it. The first time a name is set, the welcomes Werk held until then are sent to the person.
Authorization
AuthorizationheaderRequired
Authorization: Bearer <key> Authentication
Body
clientRequestIdstring, uuidRequired
An id the caller makes for this request. Sent again with the same request, it returns the first answer and changes nothing twice; sent with a different request, it is refused.
namestringRequired
The key's person's new name, which everyone in their projects sees.
From 1 to 128 characters
Response
200 The name after the change.
namestring
The key's person's name now.
Errors
400
invalid_query The query is not in the form the route takes; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).400
invalid_account_request The account request is not in the form the route takes; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).401
session_revoked The request carries no session the server holds, or its session has ended.401
session_expired The session has expired.409
session_changed The session changed while the request was in flight.409
request_conflict The request id was already used with another request, or the change it asks could not be made to the record it names.409
request_erased The request id belongs to a request whose record was erased.413
payload_too_large The request body has more bytes than the route takes.429
rate_limited More requests of this kind were sent than Werk takes within the time it counts them over.500
server_error The server could not complete the request, and it is not known whether a write it holds was made.curl
curl -X PUT "https://api.getwerk.ai/api/v1/account/name" \
-H "Authorization: Bearer wk_key_..." \
-H "Content-Type: application/json" \
-d '{
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4c01",
"name": "Maya Chen"
}'TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/account/name", {
method: "PUT",
headers: {
Authorization: "Bearer wk_key_...",
"Content-Type": "application/json",
},
body: JSON.stringify({
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4c01",
"name": "Maya Chen"
}),
});
const answer = await res.json();200JSON
{
"name": "Maya Chen"
}Send a requestPUT
It is sent with the key you give, as you. A change made here is real.
JSON
The request could not be sent, or its response could not be read.