API Reference
Log In
API Reference

/documents/{documentId}/actions

post
https://api.dev.orbit.do/v5/documents//actions

Document actions:

  • 'create-version': Returns a new presigned uploadUrl and sets uploadStatus='inUpload' until upload completes. Optionally accepts 'name' to update the document name on completion.
  • 'delete': Deletes the document and all associated links
  • 'edit-metadata': Updates the document name
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Document action request (create-version | delete | edit-metadata)

string
enum
required
Allowed:
string

Optional new filename/title to apply with the new version.

Responses

400

bad request

401

unauthorized

404

document not found

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?