Create answer rule

POST

/domains/{domain}/users/{user}/answerrules

Last modified:2026-10-09 00:28:22

OperationId:CreateAnswerrule

Creates an answer rule that decides how calls to the user are handled while one time frame applies.

Requires Basic User scope or higher for your own rules. Site Manager can manage the users in its site, Office Manager any user in its domain, Reseller any user in its territory, and Super User any user.

Send time-frame and at least one feature. The time frame must already exist for the user or the domain; * or Default creates the default rule. enabled defaults to yes. A new rule is checked after the user's existing rules. Change the order with PUT /domains/{domain}/users/{user}/answerrules/reorder.

A time frame that already has a rule for this user returns 409. Change that rule with PUT /domains/{domain}/users/{user}/answerrules/{timeframe} instead.

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/json

Examples

Responses

🟢200OK

application/json

Sent with synchronous=yes once the rule is applied: the new rule.

Bodyapplication/json

🟢202Accepted

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

🟠409Conflict

Request Example

Shell

JavaScript

Java

Swift

cURL

Forward to voicemail after hoursRing desk and mobile during business hours

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users//answerrules' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "time-frame": "After Hours",
    "enabled": "yes",
    "forward-always": {
        "enabled": "yes",
        "parameters": [
            "vmail_1001"
        ]
    },
    "phone-numbers-to-reject": {
        "enabled": "yes",
        "parameters": [
            "anonymous"
        ]
    }
}'

Response Example

200 - Ring desk and mobile during business hours

{
    "domain": "example.com",
    "user": "1001",
    "time-frame": "Business Hours",
    "ordinal-priority": 0,
    "enabled": "yes",
    "is-active": true,
    "simultaneous-ring": {
        "enabled": "yes",
        "parameters": [
            "1001",
            "1001wp",
            15555550142
        ]
    },
    "forward-no-answer": {
        "enabled": "yes",
        "parameters": [
            "vmail_1001"
        ]
    },
    "phone-numbers-to-reject": {
        "enabled": "yes",
        "parameters": [
            "anonymous"
        ]
    },
    "time_range_data": [
        {
            "time-frame": "Business Hours",
            "ordinal-order": 0,
            "start-date": "now",
            "end-date": "never",
            "day-of-week-number": "12345",
            "start-time": "08:00",
            "end-time": "17:00",
            "invert-match": "no"
        }
    ]
}

Modified at 2026-10-09 00:28:22

Read answer rule

Delete answer rule