DevelopersHow to connect an assistantKeys
Reference/Projects/Change

Join with an invitation code

POSThttps://api.getwerk.ai/api/v1/invitations/redeem

Joins the key's person to a project with an invitation code someone in it gave them.

The person who made the code is told. A code that is unknown, used or cancelled answers kind refused, and one past its 24 hours kind expired.

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.

codestringRequired

The invitation code, as given.

From 1 to 16 characters

Response

200 What came of the code.

One of 3 shapes, told apart by kind:

kindjoined
kindenum

joined when the key's person is in the project now, refused when the code does not join, expired when it ran out.

Allowed valuesjoined
projectobject

The project joined.

Show properties of projectHide properties of project
idstring, uuid

The id Werk's apps use for the key's person's view of the project, not the project's id.

projectIdstring, uuid

The project's id, the one the API's paths take.

namestring

The project's name.

From 1 to 128 characters
roleenum

The key's person's role in the project.

Allowed valuesowneradminmembercollaborator
formenum

The grammatical gender of the role's name in the reader's language; not sent today.

Allowed valuesfemininemasculine
alreadyMemberboolean

True when the key's person was already in the project.

welcomeContextobject

About the welcome Werk sends on joining.

Show properties of welcomeContextHide properties of welcomeContext
firstWelcomeOfAccountboolean

True when this is the first project the account is welcomed to.

kindrefused
kindenum

joined when the key's person is in the project now, refused when the code does not join, expired when it ran out.

Allowed valuesrefused
kindexpired
kindenum

joined when the key's person is in the project now, refused when the code does not join, expired when it ran out.

Allowed valuesexpired

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_people_requestThe people 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).
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
403personal_project_restrictedThe request acts on the signed-in person's own My Werk, which only they see, or on a reminder with no card, which lives there, and My Werk does not take this action.
409session_changedThe session changed while the request was in flight.
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.
409project_config_changedThe project's setup, or the projects the request covers, changed after the version the request names or while it ran.
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/invitations/redeem" \
  -H "Authorization: Bearer wk_key_..." \
  -H "Content-Type: application/json" \
  -d '{
    "clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4b07",
    "code": "K7M-4QX"
  }'
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/invitations/redeem", {
  method: "POST",
  headers: {
    Authorization: "Bearer wk_key_...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4b07",
    "code": "K7M-4QX"
  }),
});
const answer = await res.json();
200JSON
{
  "kind": "joined",
  "project": {
    "id": "9e3b1c75-4f2a-4d86-b0c9-5a7e2d1f8c36",
    "name": "Harbor Street kitchen"
  },
  "role": "member",
  "alreadyMember": false,
  "welcomeContext": {
    "firstWelcomeOfAccount": false
  }
}