minimusdocs
Help center

Streams

Preview sorting streams into categories

POST/streams/sort/preview/

write Change: creates or edits. Scopes

Where each stream of the selection would go, writing nothing. Each rule matches names that start with, contain or end with text and puts them in category, or in a category named new_category made for it. With unlist_old (the default) a stream leaves the category it was in.

Body

  • selectionobjectrequired

    The streams a bulk action applies to: the ones ticked (ids), or every stream the list filters select (all_matching: true with filters, which take the list's query parameters), less exclude.

    • idsstring (uuid)[]
    • all_matchingboolean

      Default: false

    • filtersobject
    • excludestring (uuid)[]
  • rulesobject[]required
    • matchstring

      Default: "starts"

    • textstringrequired
    • categorystring (uuid)can be null
    • new_categorystring
  • unlist_oldboolean

    Default: true

Response

200 OK

  • totalintegerrequired
  • movingintegerrequired
  • stayingintegerrequired
  • unmatchedintegerrequired
  • refusedintegerrequired
  • by_categoryobject[]required
  • rowsobject[]required
  • refused_rowsobject[]required

Errors

  • 400 Something sent is not valid. Each field that is wrong is named with what is wrong.
  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means