Update responder

Developing

PUT

/responders/{responder-id}

Last modified:2026-10-30 17:28:40

OperationId:UpdateResponder

Changes a responder. Only custom entries are stored. Changing a stock responder creates a custom copy of it with your changes, which then reads back as overridden; the stock entry itself is never changed. Fields you leave out keep their current values. responder-match cannot be changed; create a new responder instead.

The call engine loads responders when it starts, so a change takes effect on each server after its next NMS restart. The call answers 202, the change reaches every server shortly after, and the response says responder-applies: on-restart.

Requires the Super User scope.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢202Accepted

application/json

Accepted. Applies on each server after its next NMS restart.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Not Found

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/responders/c2lwOnN0YXJ0QHRvLXZtYWls' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "responder-name": "To V-Mail (custom)",
    "responder-filename": "custom-vm-intro.wav"
}'

Response Example

202 - Success Example

{
    "responder-id": "c2lwOnN0YXJ0QHRvLXZtYWls",
    "responder-match": "sip:start@to-vmail",
    "responder-source": "overridden",
    "responder-applies": "on-restart"
}

Modified at 2026-10-30 17:28:40

Read responder

Delete custom responder