API reference

Auto-replies

Keyword (exact, contains, starts with, or a regular expression), welcome (first message) and away (outside business hours) rules per number. Opt-out keywords always win; replies go out as replies (short pacing).

Endpoints

• GET/v2/numbers/{numberId}/auto-repliesList rulesScope: autoreplies:read
• POST/v2/numbers/{numberId}/auto-repliesCreate a ruleScope: autoreplies:write
• GET/v2/numbers/{numberId}/auto-replies/{ruleId}Get a ruleScope: autoreplies:read
• PATCH/v2/numbers/{numberId}/auto-replies/{ruleId}Update / toggle a ruleScope: autoreplies:write
• DELETE/v2/numbers/{numberId}/auto-replies/{ruleId}Delete a ruleScope: autoreplies:write
• POST/v2/numbers/{numberId}/auto-replies/enable-allEnable all rulesScope: autoreplies:write
• POST/v2/numbers/{numberId}/auto-replies/disable-allDisable all rulesScope: autoreplies:write
• DELETE/v2/numbers/{numberId}/auto-repliesDelete all rulesScope: autoreplies:write
• POST/v2/numbers/{numberId}/auto-replies/testWhich rule would answer? (no send)Scope: autoreplies:read
• GET/v2/numbers/{numberId}/auto-reply-settingsReply delayScope: autoreplies:read
• PATCH/v2/numbers/{numberId}/auto-reply-settingsSet the reply delayScope: autoreplies:write