DevelopersHow to connect an assistantKeys
Reference/Cards/Change

Answer a follow invitation

POSThttps://api.getwerk.ai/api/v1/projects/{projectId}/follow-invitations/{invitationId}/respond

Accepts an invitation to follow a card, which follows it, or ignores it.

A second answer is refused.

Authorization

AuthorizationheaderRequired

Authorization: Bearer <key> Authentication

Path parameters

projectIdstring, uuidRequired

The project's id.

invitationIdstring, uuidRequired

The invitation'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.

expectedVersionintegerRequired

The invitation's version as last read.

At least 1
actionenumRequired

accept follows the card, ignore declines the invitation.

Allowed valuesacceptignore

Response

200 What the request did.

kindenum

applied when the answer was recorded, unchanged when it already was.

Allowed valuesappliedunchanged
idstring, uuid

The invitation's id.

versioninteger

The invitation's version after the answer.

At least 1

Errors

400invalid_queryThe 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).
400invalid_followThe 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).
400follow_invitation_unavailableThe person invited has left the project, or the card is no longer visible to both people.
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
403follow_invitation_actor_not_allowedThe signed-in person may not invite anyone to follow a card here.
404conversation_not_foundThe project the request names, or its chat, is not one the signed-in person is in.
404item_not_foundThe card the request names, or its list, is not one the signed-in person can see.
404follow_invitation_not_foundThe invitation to follow a card that the request names is not one waiting for the signed-in person.
409session_changedThe session changed while the request was in flight.
409project_deletedThe project is being deleted.
409project_archivedThe project is archived, so it does not take this request.
409request_conflictThe request id was already used with another request, or the change it asks could not be made to the record it names.
409request_erasedThe request id belongs to a request whose record was erased.
409follow_invitation_staleThe card changed after the version the invitation to follow it names.
409follow_invitation_expiredThe invitation to follow a card has expired.
409follow_invitation_request_conflictThe request id was already used for another invitation to follow a card.
413payload_too_largeThe request body has more bytes than the route takes.
rate_limitedMore requests of this kind were sent than Werk takes within the time it counts them over.
500server_errorThe 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/follow-invitations/e1c6a4f8-0b3d-4e92-8f7a-5c2d9b1e6a30/respond" \
  -H "Authorization: Bearer wk_key_..." \
  -H "Content-Type: application/json" \
  -d '{
    "clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4f15",
    "expectedVersion": 1,
    "action": "accept"
  }'
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/follow-invitations/e1c6a4f8-0b3d-4e92-8f7a-5c2d9b1e6a30/respond", {
  method: "POST",
  headers: {
    Authorization: "Bearer wk_key_...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4f15",
    "expectedVersion": 1,
    "action": "accept"
  }),
});
const answer = await res.json();
200JSON
{
  "kind": "applied",
  "id": "e1c6a4f8-0b3d-4e92-8f7a-5c2d9b1e6a30",
  "version": 2
}