Leave a project
Takes the key's person out of the project.
The cards they held become free. The owner leaves only by handing the project to another person in it, named with transferToUserId; My Werk cannot be left.
Authorization
Authorization: Bearer <key> Authentication
Path parameters
The project's id.
Body
One of 2 shapes:
clientRequestIdAn 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.
transferToUserId and expectedConfigVersionAn 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.
For the owner, the person of the project who becomes its owner.
For the owner, the project's configVersion as last read; when it changed since, the request is refused.
Response
204 The key's person is out of the project.
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.not_permitted The signed-in person's role, or whose the record is, does not allow this request.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.conversation_not_found The project the request names, or its chat, is not one the signed-in person is in.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/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/leave" \
-H "Authorization: Bearer wk_key_..." \
-H "Content-Type: application/json" \
-d '{
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4d03",
"transferToUserId": "8a2e6c14-3f5d-4b9a-a7e2-61c0d9f4b3e8",
"expectedConfigVersion": 6
}'const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/leave", {
method: "POST",
headers: {
Authorization: "Bearer wk_key_...",
"Content-Type": "application/json",
},
body: JSON.stringify({
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4d03",
"transferToUserId": "8a2e6c14-3f5d-4b9a-a7e2-61c0d9f4b3e8",
"expectedConfigVersion": 6
}),
});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.