Follow a card
POSThttps://api.getwerk.ai/api/v1/projects/{projectId}/cards/{cardId}/follow
The key's person follows the card and is told of its changes.
Following a card already followed changes nothing.
Authorization
AuthorizationheaderRequired
Authorization: Bearer <key> Authentication
Path parameters
projectIdstring, uuidRequired
The project's id.
cardIdstring, uuidRequired
The card's id.
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.
Response
200 Whether the key's person follows the card now.
itemIdstring, uuid
The card's id.
followingboolean
True when the key's person follows the card now.
followerCountinteger
How many people follow the card now.
At least 0
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_follow The follow 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.404
conversation_not_found The project the request names, or its chat, is not one the signed-in person is in.404
item_not_found The card the request names, or its list, is not one the signed-in person can see.404
not_found The route or record the request names does not exist, or is not one the signed-in person can reach.409
session_changed The session changed while the request was in flight.409
project_deleted The project is being deleted.409
project_archived The project is archived, so it does not take this request.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.409
item_version_conflict The card changed after the version the request names.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 POST "https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/cards/3c9e5b17-8d2f-4a64-b1e3-7f5a0c9d2b48/follow" \
-H "Authorization: Bearer wk_key_..." \
-H "Content-Type: application/json" \
-d '{
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4f12"
}'TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/cards/3c9e5b17-8d2f-4a64-b1e3-7f5a0c9d2b48/follow", {
method: "POST",
headers: {
Authorization: "Bearer wk_key_...",
"Content-Type": "application/json",
},
body: JSON.stringify({
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4f12"
}),
});
const answer = await res.json();200JSON
{
"itemId": "3c9e5b17-8d2f-4a64-b1e3-7f5a0c9d2b48",
"following": true,
"followerCount": 2
}Send a requestPOST
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.