Remove a person
DELETEhttps://api.getwerk.ai/api/v1/projects/{projectId}/people/{personId}
Takes a person out of the project.
What they recorded stays, and the cards they held become free. Only those who may manage admins remove an admin.
Authorization
AuthorizationheaderRequired
Authorization: Bearer <key> Authentication
Path parameters
projectIdstring, uuidRequired
The project's id.
personIdstring, uuidRequired
The person'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.
Response
204 The person is out of the project.
Errors
400
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).400
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).401
session_revoked The request carries no session the server holds, or its session has ended.401
session_expired The session has expired.403
not_permitted The signed-in person's role, or whose the record is, does not allow this request.404
conversation_not_found The project the request names, or its chat, is not one the signed-in person is in.404
person_not_found The person the request is about is not one the signed-in person can reach.409
session_changed The session changed while the request was in flight.409
project_deleted The project is being deleted.409
project_archived The project is archived, so it does not take this request.409
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.409
request_erased The request id belongs to a request whose record was erased.409
project_config_changed The project's setup, or the projects the request covers, changed after the version the request names or while it ran.413
payload_too_large The request body has more bytes than the route takes.429
rate_limited More requests of this kind were sent than Werk takes within the time it counts them over.500
server_error The server could not complete the request, and it is not known whether a write it holds was made.curl
curl -X DELETE "https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/people/c4b7e9a1-2d6f-4c83-b5a0-7e1f3d9c2b64" \
-H "Authorization: Bearer wk_key_..." \
-H "Content-Type: application/json" \
-d '{
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4d02"
}'TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/people/c4b7e9a1-2d6f-4c83-b5a0-7e1f3d9c2b64", {
method: "DELETE",
headers: {
Authorization: "Bearer wk_key_...",
"Content-Type": "application/json",
},
body: JSON.stringify({
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4d02"
}),
});204
Send a requestDELETE
It is sent with the key you give, as you. A change made here is real.
JSON
The request could not be sent, or its response could not be read.