Skip to main content
DELETE
/
v1
/
documents
/
{documentId}
/
favorite
Unfavorite document
curl --request DELETE \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId}/favorite \
  --header 'Authorization: Bearer <token>'
{
  "error": "<response_code>",
  "message": "<error_reason>"
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
documentId
string
required

The document identifier

Query Parameters

​
userId
string

Requires an Organization API key. Membership ID of the user to unfavorite the document on behalf of.

Personal Access Tokens (PATs) cannot use this parameter to act on behalf of other users.

Response

Document unfavorited successfully. No response body.

This response is returned whether the document was previously favorited or not.