v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Document favorites

Favorite document

Add a document to a user's favorites. Only published documents can be favorited.

Note: Successful requests will return 204 regardless of whether the document is newly favorited or already in the user's favorites.

put/v1/documents/{documentId}/favorite

Path parameters

documentIdstring required

The document identifier

Query parameters

userIdstring

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

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

Response

Document favorited successfully. No response body.

This response is returned whether the document was newly favorited or already in favorites.