binders
Put a binder online or offline
/api/v1/binders/{binder_id}/online
Open a binder to its readers, or close it.
Closing a binder closes everything it holds; what it holds keeps its own setting and comes back with it. Inside a binder that is not online the answer is pending_online or pending_offline: the intention is recorded and applies when the parent goes online.
key
Required scope: publish
Path parameters
-
binder_idinteger · requiredId of the binder.
Request body application/json
-
onlineboolean · requiredtrueto open it to its readers,falseto close it.
Response
200
Binder
-
idintegerId, unique among the objects of its type.
-
typestringAlways
binder. -
namestringIts name.
-
rolestring or nullRole of the account on it:
owner,editororreader;nullwhen it holds none of its own. -
online_statusstringonline: open to its readers.offline: closed.pending_online/pending_offline: inside a binder that is not online, hence closed; the setting is recorded and applies when the parent goes online. -
parent_idinteger or nullId of the binder that holds it;
nullat the root of a space. -
organisation_idinteger or nullId of the organisation whose space it lives in;
nullin a personal space. -
ownerOwnerThe account that owns it.
2 fields
-
idintegerId of the account.
-
namestringIts name, or its address when it has none.
-
-
created_atdate-timeWhen it was created.
-
updated_atdate-timeWhen it was last changed.
-
descriptionstringFree text; may be empty.
-
flows_countinteger or nullNumber of flows directly inside. Given in listings,
nullelsewhere. -
sub_binders_countinteger or nullNumber of binders directly inside. Given in listings,
nullelsewhere.
Errors
-
401
No valid credential.
-
403
The credential lacks the required scope, or the account may not do this.
-
404
Nothing with that id, or nothing the account may open.
-
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.