Customize stock responder

Developing

POST

/responders/{responder-id}/customize

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

OperationId:CustomizeResponder

Copies a stock responder into your custom entries so you can change it without losing it on the next upgrade. Any fields in the body are applied to the copy. The entry then reads back as overridden.

Not a stock responder: 404. Already customized: 409; pass overwrite=yes to copy the stock values over it again.

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

Query Params

Body Params application/json

Examples

Responses

🟢202Accepted

application/json

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

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Not Found

🟠405Method Not Allowed

🟠409Conflict

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/responders/c2lwOnN0YXJ0QHRvLXZtYWls/customize?overwrite=no' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "responder-name": "Hang Up (custom)"
}'

Response Example

202 - Success Example

{
    "responder-id": "SGFuZ3Vw",
    "responder-match": "Hangup",
    "responder-source": "overridden",
    "responder-applies": "on-restart"
}

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

Delete custom responder

List dial rule applications