Set a sorter's mode

Sets the sorter's mode (query params, matching the wxs-2.0 signature). STANDARD is aliased to the stored NONE. For ROUND_ROBIN, number_of_sorts must be 1–99.

Parameters

sorterqueryrequiredstring

modequeryrequiredstring

number_of_sortsquerystring

Responses

200Updated mode

modestringrequired

number_of_sortsnumberrequired

metaobjectrequired

requestIdstringrequired

endpointstringrequired

sorterstringrequired

codestring

modestringrequired

durationMsnumberrequired

pathobject[]

400Invalid number_of_sorts

reasonstringrequired

404Sorter not found

reasonstringrequired

Sending requests from a browser

Open https://v3.revolutionstreetwxs.io/api/v3/docs to send requests to this endpoint with your API key.

Request

curl -X GET 'https://v3.revolutionstreetwxs.io/api/v3/sortation/update-mode' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY"

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/sortation/update-mode", {
  method: "GET",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
  },
});
const data = await response.json();

import requests

response = requests.get(
    "https://v3.revolutionstreetwxs.io/api/v3/sortation/update-mode",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
)
data = response.json()

Response 200

{
  "mode": "mode",
  "number_of_sorts": 1.5,
  "meta": {
    "requestId": "request id",
    "endpoint": "https://example.com/hook",
    "sorter": "sorter",
    "code": "A-01-02",
    "mode": "mode",
    "durationMs": 1.5,
    "path": [
      {}
    ]
  }
}