Create an invitation code
Makes a one-time code that joins the project, valid 24 hours.
The key's person passes it on however they like; the invited person enters it to join, and nobody is told until then. A person makes at most 20 codes an hour across their projects.
Authorization
Authorization: Bearer <key> Authentication
Path parameters
The project's id.
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.
Response
201 The new code.
The new invitation.
Show properties of invitationHide properties of invitation
The invitation's id.
When the code stops working, 24 hours after it was made.
The invitation code, shown once: the invited person enters it to join, as a member or as a collaborator when they have no plan of their own.
The project the code joins.
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.
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.not_permitted The signed-in person's role, or whose the record is, does not allow this request.conversation_not_found The project the request names, or its chat, is not one the signed-in person is in.invitation_not_found The invitation the request names is not an open one of this project.session_changed The session changed while the request was in flight.project_deleted The project is being deleted.project_archived The project is archived, so it does not take this request.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.code_key_changed The invitation code or link was made with a key the server no longer holds.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/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/invitations" \
-H "Authorization: Bearer wk_key_..." \
-H "Content-Type: application/json" \
-d '{
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4d04"
}'const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/invitations", {
method: "POST",
headers: {
Authorization: "Bearer wk_key_...",
"Content-Type": "application/json",
},
body: JSON.stringify({
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4d04"
}),
});
const answer = await res.json();{
"invitation": {
"id": "e1c6a4f8-0b3d-4e92-8f7a-5c2d9b1e6a30",
"expiresAt": "2026-11-22T14:05:00.000Z"
},
"code": "K7M-4QX",
"project": {
"id": "9e3b1c75-4f2a-4d86-b0c9-5a7e2d1f8c36",
"name": "Harbor Street kitchen"
}
}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.