Join with an invitation code
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
Authorization: Bearer <key> Authentication
Body
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.
The invitation code, as given.
Response
200 What came of the code.
One of 3 shapes, told apart by kind:
kindjoinedjoined when the key's person is in the project now, refused when the code does not join, expired when it ran out.
The project joined.
Show properties of projectHide properties of project
The id Werk's apps use for the key's person's view of the project, not the project's id.
The project's id, the one the API's paths take.
The project's name.
The key's person's role in the project.
The grammatical gender of the role's name in the reader's language; not sent today.
True when the key's person was already in the project.
About the welcome Werk sends on joining.
Show properties of welcomeContextHide properties of welcomeContext
True when this is the first project the account is welcomed to.
kindrefusedjoined when the key's person is in the project now, refused when the code does not join, expired when it ran out.
kindexpiredjoined when the key's person is in the project now, refused when the code does not join, expired when it ran out.
Errors
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).invalid_people_request The 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).session_revoked The request carries no session the server holds, or its session has ended.session_expired The session has expired.personal_project_restricted The 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.session_changed The session changed while the request was in flight.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.request_erased The request id belongs to a request whose record was erased.project_config_changed The project's setup, or the projects the request covers, changed after the version the request names or while it ran.payload_too_large The request body has more bytes than the route takes.rate_limited More requests of this kind were sent than Werk takes within the time it counts them over.server_error The server could not complete the request, and it is not known whether a write it holds was made.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"
}'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();{
"kind": "joined",
"project": {
"id": "9e3b1c75-4f2a-4d86-b0c9-5a7e2d1f8c36",
"name": "Harbor Street kitchen"
},
"role": "member",
"alreadyMember": false,
"welcomeContext": {
"firstWelcomeOfAccount": false
}
}Send a requestPOST
It is sent with the key you give, as you. A change made here is real.
The request could not be sent, or its response could not be read.