Outcome rules

GET`/api/v1/outcome-rules/email`

Email outcome rules, checked from top to bottom.

CLI: sendmock outcome-rule email list
MCP tool: sendmock_outcome_rule_list
In the app: Settings > Email > Custom outcome addresses

Answer

200 EmailOutcomeRule[]

Try it in Demo mode

POST`/api/v1/outcome-rules/email`

Add an email outcome rule.

CLI: sendmock outcome-rule email create
MCP tool: sendmock_outcome_rule_create
In the app: Settings > Email > Custom outcome addresses > Add address

Request body (application/json)

EmailOutcomeRuleInput : Body of POST and PATCH /api/v1/outcome-rules/email.

Field	Type	Description
pattern	string	Exact address, or `` wildcards, e.g. `@bounce.qa.test`.Example: `*@bounce.qa.test`
outcome	EmailOutcomeKind	What happens to a matching email: `delivered`, `hard_bounce`, `soft_bounce`, `complaint`, `unsubscribe` or `reject` (refused during SMTP `RCPT` and the HTTP send).One of: `delivered`, `hard_bounce`, `soft_bounce`, `complaint`, `unsubscribe`, `reject`Example: `hard_bounce`
smtp_code	string \| null	SMTP reply for bounces and rejects, e.g. `550 5.1.1`.Example: `550 5.1.1`
diagnostic	string \| null	The diagnostic text sent with the SMTP code.Example: `user unknown`
note	string	Why the rule exists, shown in the list.Example: `Bounce every QA signup`
is_enabled	boolean	Off rules are kept but skipped.Example: `true`

Answer

201 EmailOutcomeRule

Errors: 400, as { error: { code, message } }

Try it in Demo mode

PATCH`/api/v1/outcome-rules/email/{ruleId}`

Change an email outcome rule; send only the changed keys.

CLI: sendmock outcome-rule email update <ruleId>
MCP tool: sendmock_outcome_rule_update
In the app: Settings > Email > Custom outcome addresses > Edit, enabled switch

Request body (application/json)

EmailOutcomeRuleInputPatch

Field	Type	Description
pattern?	string	Exact address, or `` wildcards, e.g. `@bounce.qa.test`.Example: `*@bounce.qa.test`
outcome?	EmailOutcomeKind	What happens to a matching email: `delivered`, `hard_bounce`, `soft_bounce`, `complaint`, `unsubscribe` or `reject` (refused during SMTP `RCPT` and the HTTP send).One of: `delivered`, `hard_bounce`, `soft_bounce`, `complaint`, `unsubscribe`, `reject`Example: `hard_bounce`
smtp_code?	string \| null	SMTP reply for bounces and rejects, e.g. `550 5.1.1`.Example: `550 5.1.1`
diagnostic?	string \| null	The diagnostic text sent with the SMTP code.Example: `user unknown`
note?	string	Why the rule exists, shown in the list.Example: `Bounce every QA signup`
is_enabled?	boolean	Off rules are kept but skipped.Example: `true`

Answer

200 EmailOutcomeRule

Errors: 400, 404, as { error: { code, message } }

Try it in Demo mode

DELETE`/api/v1/outcome-rules/email/{ruleId}`

Delete an email outcome rule.

CLI: sendmock outcome-rule email delete <ruleId>
MCP tool: sendmock_outcome_rule_delete
In the app: Settings > Email > Custom outcome addresses > Delete

Answer

204 No content

Try it in Demo mode

POST`/api/v1/outcome-rules/email/{ruleId}/move`

Move an email outcome rule up or down.

CLI: sendmock outcome-rule email move <ruleId>
MCP tool: sendmock_outcome_rule_move
In the app: Settings > Email > Custom outcome addresses > Move up, Move down

Request body (application/json)

OutcomeRuleMove : Body of POST /api/v1/outcome-rules/{kind}/{ruleId}/move.

Field	Type	Description
direction	"up" \| "down"	`up` moves the rule one place earlier in the order, `down` one place later.One of: `up`, `down`Example: `up`

Answer

200 EmailOutcomeRule[]

Errors: 404, as { error: { code, message } }

Try it in Demo mode

GET`/api/v1/outcome-rules/sms`

SMS outcome rules, checked from top to bottom.

CLI: sendmock outcome-rule sms list
MCP tool: sendmock_outcome_rule_list
In the app: Settings > SMS > Custom outcome numbers

Answer

200 SmsOutcomeRule[]

Try it in Demo mode

POST`/api/v1/outcome-rules/sms`

Add an SMS outcome rule.

CLI: sendmock outcome-rule sms create
MCP tool: sendmock_outcome_rule_create
In the app: Settings > SMS > Custom outcome numbers > Add number

Request body (application/json)

SmsOutcomeRuleInput : Body of POST and PATCH /api/v1/outcome-rules/sms.

Field	Type	Description
match_field	"to" \| "from"	Match the pattern against the recipient (`to`) or the sender (`from`).One of: `to`, `from`Example: `to`
pattern	string	Exact E.164 number, or `` for any digits, e.g. `+1555777`.Example: `+1555777*`
outcome	SmsOutcomeKind	What happens to a matching message: `reject` (the send fails), `undelivered`, `failed`, `delayed_delivery` or `read`.One of: `reject`, `undelivered`, `failed`, `delayed_delivery`, `read`Example: `undelivered`
error_code	string \| null	Required for `reject`, `undelivered` and `failed`.Example: `30003`
delay_seconds	number \| null	Required for `delayed_delivery`.Example: `30`
note	string	Why the rule exists, shown in the list.Example: `Unreachable handset for the retry test`
is_enabled	boolean	Off rules are kept but skipped.Example: `true`

Answer

201 SmsOutcomeRule

Errors: 400, as { error: { code, message } }

Try it in Demo mode

PATCH`/api/v1/outcome-rules/sms/{ruleId}`

Change an SMS outcome rule; send only the changed keys.

CLI: sendmock outcome-rule sms update <ruleId>
MCP tool: sendmock_outcome_rule_update
In the app: Settings > SMS > Custom outcome numbers > Edit, enabled switch

Request body (application/json)

SmsOutcomeRuleInputPatch

Field	Type	Description
match_field?	"to" \| "from"	Match the pattern against the recipient (`to`) or the sender (`from`).One of: `to`, `from`Example: `to`
pattern?	string	Exact E.164 number, or `` for any digits, e.g. `+1555777`.Example: `+1555777*`
outcome?	SmsOutcomeKind	What happens to a matching message: `reject` (the send fails), `undelivered`, `failed`, `delayed_delivery` or `read`.One of: `reject`, `undelivered`, `failed`, `delayed_delivery`, `read`Example: `undelivered`
error_code?	string \| null	Required for `reject`, `undelivered` and `failed`.Example: `30003`
delay_seconds?	number \| null	Required for `delayed_delivery`.Example: `30`
note?	string	Why the rule exists, shown in the list.Example: `Unreachable handset for the retry test`
is_enabled?	boolean	Off rules are kept but skipped.Example: `true`

Answer

200 SmsOutcomeRule

Errors: 400, 404, as { error: { code, message } }

Try it in Demo mode

DELETE`/api/v1/outcome-rules/sms/{ruleId}`

Delete an SMS outcome rule.

CLI: sendmock outcome-rule sms delete <ruleId>
MCP tool: sendmock_outcome_rule_delete
In the app: Settings > SMS > Custom outcome numbers > Delete

Answer

204 No content

Try it in Demo mode

POST`/api/v1/outcome-rules/sms/{ruleId}/move`

Move an SMS outcome rule up or down.

CLI: sendmock outcome-rule sms move <ruleId>
MCP tool: sendmock_outcome_rule_move
In the app: Settings > SMS > Custom outcome numbers > Move up, Move down

Request body (application/json)

OutcomeRuleMove : Body of POST /api/v1/outcome-rules/{kind}/{ruleId}/move.

Field	Type	Description
direction	"up" \| "down"	`up` moves the rule one place earlier in the order, `down` one place later.One of: `up`, `down`Example: `up`

Answer

200 SmsOutcomeRule[]

Errors: 404, as { error: { code, message } }

Try it in Demo mode

POST`/api/v1/outcome-rules/email/test`

Which custom rule, magic address or profile decides an address's outcome.

CLI: sendmock outcome-rule email test <address>
MCP tool: sendmock_outcome_rule_test
In the app: Settings > Email > Test an address

Request body (application/json)

EmailOutcomeTestRequest : Body of POST /api/v1/outcome-rules/email/test.

Field	Type	Description
address	string	The address to test against the outcome rules and magic addresses.Example: `[email protected]`

Answer

200 OutcomeTestResult

Try it in Demo mode

POST`/api/v1/outcome-rules/sms/test`

Which custom rule, magic number or profile decides a number's outcome.

CLI: sendmock outcome-rule sms test <number>
MCP tool: sendmock_outcome_rule_test
In the app: Settings > SMS > Test a number

Request body (application/json)

SmsOutcomeTestRequest : Body of POST /api/v1/outcome-rules/sms/test.

Field	Type	Description
number	string	The number to test against the outcome rules and Twilio's magic numbers.Example: `+15005550001`
match_field	"to" \| "from"	Whether the number is the message's recipient (`to`) or sender (`from`).One of: `to`, `from`Example: `to`

Answer

200 OutcomeTestResult

Try it in Demo mode

Outcome rules

GET/api/v1/outcome-rules/email

Answer

POST/api/v1/outcome-rules/email

Request body (application/json)

Answer

PATCH/api/v1/outcome-rules/email/{ruleId}

Request body (application/json)

Answer

DELETE/api/v1/outcome-rules/email/{ruleId}

Answer

POST/api/v1/outcome-rules/email/{ruleId}/move

Request body (application/json)

Answer

GET/api/v1/outcome-rules/sms

Answer

POST/api/v1/outcome-rules/sms

Request body (application/json)

Answer

PATCH/api/v1/outcome-rules/sms/{ruleId}

Request body (application/json)

Answer

DELETE/api/v1/outcome-rules/sms/{ruleId}

Answer

POST/api/v1/outcome-rules/sms/{ruleId}/move

Request body (application/json)

Answer

POST/api/v1/outcome-rules/email/test

Request body (application/json)

Answer

POST/api/v1/outcome-rules/sms/test

Request body (application/json)

Answer

GET`/api/v1/outcome-rules/email`

POST`/api/v1/outcome-rules/email`

PATCH`/api/v1/outcome-rules/email/{ruleId}`

DELETE`/api/v1/outcome-rules/email/{ruleId}`

POST`/api/v1/outcome-rules/email/{ruleId}/move`

GET`/api/v1/outcome-rules/sms`

POST`/api/v1/outcome-rules/sms`

PATCH`/api/v1/outcome-rules/sms/{ruleId}`

DELETE`/api/v1/outcome-rules/sms/{ruleId}`

POST`/api/v1/outcome-rules/sms/{ruleId}/move`

POST`/api/v1/outcome-rules/email/test`

POST`/api/v1/outcome-rules/sms/test`