POST
/api/v1/server/loas/{loaId}/end
Request
Response
200
Success
Authorization
AuthorizationstringrequiredYour API token as
Bearer YOUR_TOKEN. Create one in your server's dashboard settings.Path parameters
loaIdstringrequiredBody
performedBystring | nullMember ID of a staff member acting on someone else's shift or LOA. Leave it out to act as the owner.
Response
200 Success
createdAtintegerrequiredWhen it was created.
extensionRequestsobject[]requiredRequests to extend the leave.
idstringrequiredUnique ID.
memberIdstringrequiredMember ID of the member on leave.
reasonHistoryobject[]requiredEarlier versions of the reason.
serverIdstringrequiredServer ID, or department ID for department LOAs.
startTypeintegerrequired0 starts when approved, 1 starts at
startAt.statusintegerrequired0 Active, 1 Denied, 2 Ended, 3 Pending review, 4 Expired, 5 Approved and waiting to start, 6 Cancelled.approveReasonstring | nullThe reviewer's reason for approving it.
cancelledAtinteger | nullWhen the member cancelled it.
denyReasonstring | nullThe reviewer's reason for denying it.
endAtinteger | nullWhen the leave is scheduled to end.
endedAtinteger | nullWhen the leave actually ended.
endedBystring | nullMember ID of who ended it early.
expiredAtinteger | nullWhen it expired.
reasonstring | nullThe member's reason.
reviewedAtinteger | nullWhen it was reviewed.
reviewedBystring | nullMember ID of the reviewer.
startAtinteger | nullWhen it's scheduled to start.
startedAtinteger | nullWhen the leave actually started.
Errors
| Status | Meaning |
|---|---|
400 | Invalid request. validation_failed lists each invalid field in details.fields. |
401 | Missing, invalid or expired token |
403 | Success |
404 | Not found |
409 | Already ended, or pending when ended by staff |
429 | Rate limited. See Retry-After and details. |
500 | Internal server error |
502 | next did not confirm the write. Check whether it applied before retrying. |
503 | Write endpoints are not configured on this deployment |