Reorder user hold messages - NetSapiens API v2

Changes the order of the hold messages by renumbering them.

Basic User, Advanced User, Simple User, and Call Center Agent can change their own hold messages. Site Manager can change the hold messages of users at its own site. Office Manager, Call Center Supervisor, Route Manager, Reseller, and Super User can change any user's. The read-only scopes get 403.

List the current indexes in ordinal-order in the order you want. The listed messages are renumbered into the same set of indexes, sorted: [3, 1, 2] moves the message at 3 to 1, 1 to 2, and 2 to 3. Messages you leave out keep their index. Every listed index must be a distinct whole number with a message: a repeated or non-numeric index returns 400, and an index with no message returns 404; either way nothing moves. The files are renamed on the server that handles the request before the response, and copied to the other servers over the SBUS file journal. The call answers 202 by default, which here means applied on this server.

Reordering does not close a gap left by a delete: [1, 3] keeps 1 and 3.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟠400Bad Request

application/json

ordinal-order is missing, lists something other than whole numbers, or lists an index more than once. Nothing moves. Send each current index once.

Bodyapplication/json

🟠401Authentication Required

🟠404Record not found

🟢202Accepted

🟠403Forbidden

🔴500Internal Server Error

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users//msg/reorder' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "ordinal-order": [ 3, 1, 2 ] }'