WinShopAPI docs
ReferenceDocumentsIntakes

Lock a intake

Locks the intake for the calling user so other users cannot edit or process it. Returns 400 when it is already locked. Release it with `DELETE {documentId}/lock`. Requires `Permissions.Intake.Update`.

POST
/api/documents/intakes/{documentId}/lock

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

documentId*integer
Formatint32

Response Body

response?unknownapplication/octet-stream
curl -X POST 'https://<your-instance>/api/documents/intakes/0/lock' \  -H 'Authorization: Bearer <access-token>'
null

Get the lock state of a intake GET

Returns whether the intake is locked against concurrent edits and, when it is, the name of the user holding the lock. Requires `Permissions.Intake.View`.

Unlock a intake DELETE

Releases the lock on the intake. Returns 400 when the lock belongs to another user. Requires `Permissions.Intake.Update`.