UnlockCoauthLock

A Coauth lock can be released by the clients using UnlockCoauthLock operation on a file. The host will determine the lock entry to be released by using the file ID and CoauthLockId.

Parameters

file_id – Required. Passed as part of the endpoint.

Endpoint

/wopi/files/(file_id) – Required.

Query parameters

access_token (string) – Required. An access token that the host uses to determine whether the request is authorized.

Request method

POST

Request headers

• X-WOPI-Override (string) – Required. The string is UNLOCK_COAUTH_LOCK.
• X-WOPI-CoauthLockId (string) – Required. A string provided by the client that the host must use to uniquely identify the client for the lock on the file. Size limit: 1,024 ASCII characters.

Response headers

• X-WOPI-FailureReason (string) – Optional. Used only for logging purposes. It should be set on non-200 OK responses.

Status codes

• 200 OK – Success. Coauth lock was released on the file for the client.
• 400 Bad Request
  • The required parameters weren't provided.
  • The request was incorrectly formatted.
  • The header size wasn't within an acceptable range.
• 401 Unauthorized – Invalid access token
• 404 Not Found
  • The file doesn't exist.
  • The access token doesn't have edit permissions.
• 409 Conflict
  • The lock doesn't exist.
• 500 Internal Server Error – Server error
• 501 Not Implemented – Operation not supported
• 503 Server Busy

Next steps

Learn about changes in these CoauthLocks methods for WOPI coauthoring extensions:

• GetCoauthLock
• RefreshCoauthLock
• GetCoauthTable