favorites
Add a favorite
/api/v1/favorites
Keep a binder or a flow the account can see -- its own, one shared with it, or a public one. Adding it again answers 200 with the favorite already there.
key
Required scope: write
Request body application/json
-
typestring · requiredWhat to keep: a binder or a flow.
-
idinteger · requiredId of the binder or the flow.
Response
200
Favorite
-
idintegerId of the favorite.
-
typestringWhat it keeps: a binder or a flow.
-
entity_idinteger or nullId of the binder or the flow; null once it was deleted.
-
namestringIts name, as last seen while it opened.
-
statestringavailable: it opens.closed: still there, taken offline by its author -- it does not open.unavailable: deleted, or no longer shared with you, no longer public, or out of an organisation you left. A favorite is never removed on its own. -
created_atdate-timeWhen it was added.
Errors
-
401
No valid credential.
-
403
The credential lacks the required scope, or the account may not do this.
-
409
The current state of the content forbids the request.
-
422
A value is missing or malformed.
-
429
Too many requests;
Retry-Aftergives the seconds to wait.