Sender Rules & Inbound Firewall API

Configure inbound email firewall rules to allowlist trusted senders or reject unwanted addresses, full domains, and wildcard patterns at the network edge.

Quick Reference#

Endpoint	Method	Required Scope	Description
`/v1/sender-rules/whitelist`	`GET`	`sender_rules:read`	List configured allowed sender rules.
`/v1/sender-rules/whitelist`	`POST`	`sender_rules:write`	Create an allowlist rule for an address, domain, or pattern.
`/v1/sender-rules/whitelist`	`PATCH`	`sender_rules:write`	Toggle or update an allowlist rule.
`/v1/sender-rules/whitelist`	`DELETE`	`sender_rules:write`	Delete an allowlist rule.
`/v1/sender-rules/whitelist/stats`	`GET`	`sender_rules:read`	Retrieve allowlist volume and monthly trend metrics.
`/v1/sender-rules/blacklist`	`GET`	`sender_rules:read`	List configured blocked sender rules.
`/v1/sender-rules/blacklist`	`POST`	`sender_rules:write`	Create a denylist rule to reject senders or domains.
`/v1/sender-rules/blacklist`	`PATCH`	`sender_rules:write`	Toggle or update a denylist rule.
`/v1/sender-rules/blacklist`	`DELETE`	`sender_rules:write`	Delete a denylist rule.
`/v1/sender-rules/blacklist/stats`	`GET`	`sender_rules:read`	Retrieve blocked volume and monthly trend metrics.

Inbound Firewall Architecture#

The AliasFleet Inbound Firewall evaluates incoming messages at the earliest possible stage of the email delivery pipeline:

Edge Rejection: When an inbound SMTP transaction arrives from a blocked sender or domain, the firewall terminates the session during the MAIL FROM envelope handshake with an RFC 5321 550 5.7.1 permanent failure code. The message body is never accepted or stored.
Mutual Exclusivity Invariant: A sender pattern cannot exist on both your allowlist and your denylist. If you attempt to allow an address that is currently blocked, the API rejects the request with CROSS_TABLE_CONFLICT.
Pattern Matching Hierarchy:
- Exact: Matches specific email addresses (spammer@example.com).
- Domain: Matches all senders under a domain (badcompany.com), with optional recursive subdomain coverage (includeSubdomains: true).
- Pattern: Advanced wildcard matching (*@promo.*.com, alert*@monitoring.internal).

List Allowed Sender Rules#

GET /v1/sender-rules/whitelist

Returns a paginated list of allowed sender rules configured for your account.

Scope: sender_rules:readRate Limit: 60 req/minIdempotent: Yes

Query Parameters#

Parameter	Type	Required	Default	Description
`page`	`integer`	Optional	`1`	Page number for pagination.
`limit`	`integer`	Optional	`50`	Number of records per page (max `100`).
`search`	`string`	Optional	—	Case-insensitive filter on `email_pattern`.
`includeGlobal`	`boolean`	Optional	`false`	When `true`, includes platform-wide system rules alongside account rules.

Request Headers#

Header	Type	Required	Description
`Authorization`	`string`	Optional*	`Bearer afp_...`
`x-api-key`	`string`	Optional*	`afp_...` (*Provide either `Authorization` or `x-api-key`).
`Accept`	`string`	Yes	`application/json`

cURL Example#

Terminal

curl -X GET "https://api.aliasfleet.com/v1/sender-rules/whitelist?page=1&limit=2" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Accept: application/json"

Response (`200 OK`)#

JSON

{  "entries": [    {      "id": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f",      "user_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",      "email_pattern": "vip-notifications@partner.com",      "pattern_type": "exact",      "include_subdomains": false,      "reason": "Critical billing and invoice updates",      "source": "manual",      "is_active": true,      "allowed_count": 48,      "created_at": "2026-08-20T10:00:00.000Z",      "updated_at": "2026-08-20T10:00:00.000Z"    }  ],  "pagination": {    "page": 1,    "limit": 2,    "total": 1,    "totalPages": 1  }}

Response Fields#

Field	Type	Description
`entries`	`array`	List of allowlisted sender entries.
`entries[].id`	`string`	Unique rule identifier.
`entries[].user_id`	`string`	Account user ID owning this rule.
`entries[].email_pattern`	`string`	Configured address, domain, or wildcard pattern.
`entries[].pattern_type`	`string`	Matching type (`"exact"`, `"domain"`, or `"pattern"`).
`entries[].include_subdomains`	`boolean`	Whether matching applies recursively to subdomains.
`entries[].reason`	`string \| null`	Human note explaining why sender is trusted.
`entries[].source`	`string`	Rule source mechanism (`"manual"`, `"api"`).
`entries[].is_active`	`boolean`	Whether rule is actively enforced.
`entries[].allowed_count`	`integer`	Counter of messages processed via this allow rule.
`entries[].created_at`	`string`	ISO 8601 creation timestamp.
`pagination`	`object`	Page index and total items metadata.

Create Allowed Sender Rule#

POST /v1/sender-rules/whitelist

Adds a sender address, domain, or wildcard pattern to your inbound allowlist.

Scope: sender_rules:writeRate Limit: 60 req/minIdempotent: Yes

Request Body Schema#

Field	Type	Required	Constraints	Description
`emailPattern`	`string`	Yes	1–255 chars	Email (`user@domain.com`), domain (`partner.com`), or wildcard pattern (`@.corp.com`).
`patternType`	`string`	Optional	`"exact"`, `"domain"`, `"pattern"`	Pattern evaluation strategy. Defaults to `"exact"`.
`includeSubdomains`	`boolean`	Optional	Boolean	When `true` with `patternType: "domain"`, matches subdomains (e.g. `*.partner.com`).
`reason`	`string`	Optional	Max 255 chars	Contextual note explaining why the sender is allowlisted.
`source`	`string`	Optional	Max 50 chars	Origin tag: `"manual"`, `"quick_action"`, or `"api"`. Defaults to `"manual"`.

cURL Example#

Terminal

curl -X POST "https://api.aliasfleet.com/v1/sender-rules/whitelist" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Content-Type: application/json" \  -d '{    "emailPattern": "partner-network.com",    "patternType": "domain",    "includeSubdomains": true,    "reason": "Authorized B2B syndication partner"  }'

Response (`201 Created`)#

JSON

{  "success": true,  "entry": {    "id": "3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d",    "user_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",    "email_pattern": "partner-network.com",    "pattern_type": "domain",    "include_subdomains": true,    "reason": "Authorized B2B syndication partner",    "source": "manual",    "is_active": true,    "allowed_count": 0,    "created_at": "2026-09-04T12:00:00.000Z",    "updated_at": "2026-09-04T12:00:00.000Z"  },  "message": "partner-network.com has been whitelisted"}

Response Fields#

Field	Type	Description
`success`	`boolean`	Confirms rule creation.
`entry`	`object`	Newly created allowlist rule record.
`message`	`string`	User confirmation message.

Error Responses#

Status Code	Code	Error Message	Reason
`400`	`INVALID_PATTERN`	`"Please enter a valid email address."`	The `emailPattern` string is malformed or invalid syntax for the chosen `patternType`.
`402`	`ENTITLEMENT_REQUIRED`	`"Domain and wildcard pattern rules are only available on Pro and Business plans."`	Domain and wildcard pattern rules require `advanced_routing` feature access (Pro or Business plan). Returns `{ error, code: "ENTITLEMENT_REQUIRED", feature: "advanced_routing" }`.
`409`	`CROSS_TABLE_CONFLICT`	`"This pattern is already on your Blocked Senders (blacklist). A sender cannot be both allowed and blocked."`	The pattern already exists on your denylist. Remove it from the denylist first.
`409`	`ALREADY_EXISTS`	`"This sender is already whitelisted"`	The pattern is already present on your allowlist. Includes `existingId`.

Update Allowed Sender Rule#

PATCH /v1/sender-rules/whitelist

Toggles the active state or updates the description metadata for an existing allowlist rule.

Scope: sender_rules:writeRate Limit: 60 req/minIdempotent: Yes

Request Body Schema#

Field	Type	Required	Constraints	Description
`id`	`string`	Yes	Rule UUID	Unique identifier of the rule to modify.
`isActive`	`boolean`	Optional	Boolean	Activates or pauses rule enforcement.
`reason`	`string`	Optional	Max 255 chars	Updated note or rationale.
`includeSubdomains`	`boolean`	Optional	Boolean	Whether domain matching extends to subdomains.

cURL Example#

Terminal

curl -X PATCH "https://api.aliasfleet.com/v1/sender-rules/whitelist" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Content-Type: application/json" \  -d '{    "id": "3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d",    "isActive": false,    "reason": "Temporarily disabled during vendor security audit"  }'

Response (`200 OK`)#

JSON

{  "success": true,  "entry": {    "id": "3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d",    "user_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",    "email_pattern": "partner-network.com",    "pattern_type": "domain",    "include_subdomains": true,    "reason": "Temporarily disabled during vendor security audit",    "source": "manual",    "is_active": false,    "allowed_count": 12,    "created_at": "2026-09-04T12:00:00.000Z",    "updated_at": "2026-09-04T12:15:00.000Z"  }}

Response Fields#

Field	Type	Description
`success`	`boolean`	Confirms rule was updated.
`entry`	`object`	Updated allowlist record.

Error Responses#

Status Code	Code	Error Message	Reason
`400`	`NO_UPDATES`	`"No updates provided"`	Request body contains no updatable fields.
`404`	`NOT_FOUND`	`"Rule not found"`	No rule matching the provided `id` was found.

Delete Allowed Sender Rule#

DELETE /v1/sender-rules/whitelist

Permanently deletes an allowlist rule from your account.

Scope: sender_rules:writeRate Limit: 60 req/minIdempotent: Yes

Query Parameters#

Parameter	Type	Required	Description
`id`	`string`	Yes	Unique identifier (UUID) of the allowlist rule to delete passed as a query string parameter.

cURL Example#

Terminal

curl -X DELETE "https://api.aliasfleet.com/v1/sender-rules/whitelist?id=3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e"

Response (`200 OK`)#

JSON

{  "success": true,  "message": "Removed from whitelist"}

Response Fields#

Field	Type	Description
`success`	`boolean`	Confirms deletion.
`message`	`string`	Outcome status message.

Error Responses#

Status Code	Code	Error Message	Reason
`400`	`ID_REQUIRED`	`"id is required"`	The `?id=` query parameter was omitted.

Get Allowlist Metrics#

GET /v1/sender-rules/whitelist/stats

Returns aggregated statistics regarding allowlist rule counts, lifetime forwarded volumes, and monthly trends.

Scope: sender_rules:readRate Limit: 60 req/minIdempotent: Yes

cURL Example#

Terminal

curl -X GET "https://api.aliasfleet.com/v1/sender-rules/whitelist/stats" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Accept: application/json"

Response (`200 OK`)#

JSON

{  "stats": {    "totalRules": 14,    "activeRules": 12,    "rulesTrend": 20,    "totalAllowedEmails": 384,    "newThisMonth": 3  }}

Response Fields#

Field	Type	Description
`stats.totalRules`	`integer`	Total allowlist rules defined.
`stats.activeRules`	`integer`	Count of rules actively enforced.
`stats.rulesTrend`	`integer`	Month-over-month growth percentage in rules.
`stats.totalAllowedEmails`	`integer`	Total forwarded messages permitted through allowlist rules.
`stats.newThisMonth`	`integer`	Count of rules added during the current billing cycle.

List Blocked Sender Rules#

GET /v1/sender-rules/blacklist

Returns a paginated list of blocked sender rules (denylist) configured for your account.

Scope: sender_rules:readRate Limit: 60 req/minIdempotent: Yes

Query Parameters#

Parameter	Type	Required	Default	Description
`page`	`integer`	Optional	`1`	Page number for pagination.
`limit`	`integer`	Optional	`50`	Number of records per page (max `100`).
`search`	`string`	Optional	—	Case-insensitive filter on `email_pattern`.
`includeGlobal`	`boolean`	Optional	`false`	When `true`, includes platform-wide threat network rules alongside account rules.

cURL Example#

Terminal

curl -X GET "https://api.aliasfleet.com/v1/sender-rules/blacklist?page=1&limit=2" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Accept: application/json"

Response (`200 OK`)#

JSON

{  "entries": [    {      "id": "b1a2b3c4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",      "user_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",      "email_pattern": "spammer.org",      "pattern_type": "domain",      "include_subdomains": true,      "reason": "Phishing domain targeting credentials",      "source": "manual",      "is_active": true,      "blocked_count": 142,      "created_at": "2026-08-15T09:30:00.000Z",      "updated_at": "2026-08-15T09:30:00.000Z"    }  ],  "pagination": {    "page": 1,    "limit": 2,    "total": 1,    "totalPages": 1  }}

Response Fields#

Field	Type	Description
`entries`	`array`	List of blocked sender rules.
`entries[].id`	`string`	Unique rule identifier.
`entries[].user_id`	`string`	Account user ID.
`entries[].email_pattern`	`string`	Configured blocked pattern.
`entries[].pattern_type`	`string`	Mode (`"exact"`, `"domain"`, or `"pattern"`).
`entries[].include_subdomains`	`boolean`	Subdomain recursive blocking flag.
`entries[].reason`	`string \| null`	Stored note or threat classification.
`entries[].source`	`string`	Rule source mechanism.
`entries[].is_active`	`boolean`	Whether rule is actively rejecting messages.
`entries[].blocked_count`	`integer`	Count of rejected SMTP connection attempts.
`entries[].created_at`	`string`	ISO 8601 creation timestamp.
`pagination`	`object`	Page index and total items metadata.

Create Blocked Sender Rule#

POST /v1/sender-rules/blacklist

Creates an inbound denylist rule to reject messages from a specific address, domain, or wildcard pattern. Blocked messages are rejected at the edge without entering your forwarding stream.

Scope: sender_rules:writeRate Limit: 60 req/minIdempotent: Yes

Request Body Schema#

Field	Type	Required	Constraints	Description
`emailPattern`	`string`	Yes	1–255 chars	Email (`bad@spam.com`), domain (`spammer.org`), or wildcard pattern (`@.phishing.com`).
`patternType`	`string`	Optional	`"exact"`, `"domain"`, `"pattern"`	Matching mode. Auto-promoted to `domain` or `pattern` if wildcard characters are detected.
`includeSubdomains`	`boolean`	Optional	Boolean	When `true` with `patternType: "domain"`, blocks all subdomains (e.g. `*.spammer.org`).
`reason`	`string`	Optional	Max 255 chars	Rationale or internal audit comment.
`source`	`string`	Optional	Max 50 chars	Origin tag: `"manual"`, `"quick_action"`, `"automated_filter"`, or `"api"`. Defaults to `"manual"`.

cURL Example#

Terminal

curl -X POST "https://api.aliasfleet.com/v1/sender-rules/blacklist" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Content-Type: application/json" \  -d '{    "emailPattern": "scamnetwork.xyz",    "patternType": "domain",    "includeSubdomains": true,    "reason": "Persistent scam outreach campaign"  }'

Response (`201 Created`)#

JSON

{  "success": true,  "entry": {    "id": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",    "user_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",    "email_pattern": "scamnetwork.xyz",    "pattern_type": "domain",    "include_subdomains": true,    "reason": "Persistent scam outreach campaign",    "source": "manual",    "is_active": true,    "blocked_count": 0,    "created_at": "2026-09-04T12:00:00.000Z",    "updated_at": "2026-09-04T12:00:00.000Z"  },  "message": "scamnetwork.xyz has been blacklisted"}

Response Fields#

Field	Type	Description
`success`	`boolean`	Confirms denylist rule creation.
`entry`	`object`	Newly registered blocked sender rule.
`message`	`string`	Outcome status message.

Error Responses#

Status Code	Code	Error Message	Reason
`400`	`INVALID_PATTERN`	`"Please enter a valid domain name (e.g. spammer.com)."`	The pattern syntax does not conform to RFC email or hostname specifications.
`402`	`ENTITLEMENT_REQUIRED`	`"Domain and wildcard pattern rules are only available on Pro and Business plans."`	Domain and wildcard pattern rules require `advanced_routing` feature access (Pro or Business subscription). Returns `{ error, code: "ENTITLEMENT_REQUIRED", feature: "advanced_routing" }`.
`409`	`CROSS_TABLE_CONFLICT`	`"This pattern is already on your Allowed Senders (whitelist). A sender cannot be both allowed and blocked."`	Pattern already exists on your allowlist. Remove it from the allowlist first.
`409`	`ALREADY_EXISTS`	`"This sender is already blacklisted"`	Pattern is already present in your denylist. Includes `existingId`.

Update Blocked Sender Rule#

PATCH /v1/sender-rules/blacklist

Updates an existing blocked sender rule, allowing you to toggle rule enforcement on or off without deleting the rule history and counters.

Scope: sender_rules:writeRate Limit: 60 req/minIdempotent: Yes

Request Body Schema#

Field	Type	Required	Constraints	Description
`id`	`string`	Yes	Rule UUID	Unique identifier of the denylist rule to modify.
`isActive`	`boolean`	Optional	Boolean	Activates or pauses rule enforcement.
`reason`	`string`	Optional	Max 255 chars	Updated note or rationale.
`includeSubdomains`	`boolean`	Optional	Boolean	Whether domain matching extends to subdomains.

cURL Example#

Terminal

curl -X PATCH "https://api.aliasfleet.com/v1/sender-rules/blacklist" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Content-Type: application/json" \  -d '{    "id": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",    "isActive": false,    "reason": "Deactivated pending review of false positive"  }'

Response (`200 OK`)#

JSON

{  "success": true,  "entry": {    "id": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",    "user_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",    "email_pattern": "scamnetwork.xyz",    "pattern_type": "domain",    "include_subdomains": true,    "reason": "Deactivated pending review of false positive",    "source": "manual",    "is_active": false,    "blocked_count": 27,    "created_at": "2026-09-04T12:00:00.000Z",    "updated_at": "2026-09-04T12:20:00.000Z"  }}

Response Fields#

Field	Type	Description
`success`	`boolean`	Confirms rule was updated.
`entry`	`object`	Updated denylist record.

Error Responses#

Status Code	Code	Error Message	Reason
`400`	`NO_UPDATES`	`"No updates provided"`	Request body contains no updatable fields.
`404`	`NOT_FOUND`	`"Rule not found"`	No rule matching the provided `id` was found.

Delete Blocked Sender Rule#

DELETE /v1/sender-rules/blacklist

Permanently deletes a blocked sender rule from your account. Messages from the sender will once again be evaluated according to standard forwarding rules.

Scope: sender_rules:writeRate Limit: 60 req/minIdempotent: Yes

Query Parameters#

Parameter	Type	Required	Description
`id`	`string`	Yes	Unique identifier (UUID) of the denylist rule to delete passed as a query string parameter.

cURL Example#

Terminal

curl -X DELETE "https://api.aliasfleet.com/v1/sender-rules/blacklist?id=e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e"

Response (`200 OK`)#

JSON

{  "success": true,  "message": "Removed from blacklist"}

Response Fields#

Field	Type	Description
`success`	`boolean`	Confirms rule was deleted.
`message`	`string`	Outcome status message.

Error Responses#

Status Code	Code	Error Message	Reason
`400`	`ID_REQUIRED`	`"id is required"`	The `?id=` query parameter was omitted.

Get Denylist Metrics#

GET /v1/sender-rules/blacklist/stats

Returns aggregated statistics regarding blocked sender rules, lifetime rejected messages, and month-over-month threat volume trends.

Scope: sender_rules:readRate Limit: 60 req/minIdempotent: Yes

cURL Example#

Terminal

curl -X GET "https://api.aliasfleet.com/v1/sender-rules/blacklist/stats" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Accept: application/json"

Response (`200 OK`)#

JSON

{  "total": 35,  "active": 32,  "totalBlocked": 1842,  "newThisMonth": 6,  "newLastMonth": 4,  "blacklistTrend": 50,  "blockedTrend": -12,  "blockedThisMonth": 210,  "blockedLastMonth": 238}

Response Fields#

Field	Type	Description
`total`	`integer`	Total denylist rules configured.
`active`	`integer`	Count of rules actively blocking incoming mail.
`totalBlocked`	`integer`	Total inbound SMTP connection handshakes terminated by denylist rules.
`newThisMonth`	`integer`	Count of rules added during the active billing period.
`newLastMonth`	`integer`	Count of rules added during previous cycle.
`blacklistTrend`	`integer`	Percentage increase or decrease in rules.
`blockedTrend`	`integer`	Percentage change in blocked volume compared to previous cycle.
`blockedThisMonth`	`integer`	Total emails dropped during current billing period.
`blockedLastMonth`	`integer`	Total emails dropped during prior billing period.

Frequently Asked Questions

No. The firewall enforces strict mutual exclusivity. Creating a rule for an entry that exists in the opposing table returns HTTP 409 CROSS_TABLE_CONFLICT.

Rules propagate to the inbound firewall immediately. Incoming SMTP transactions from blocked senders are rejected in real time during the initial envelope handshake.

Wildcard patterns support asterisk (*) and question mark (?) wildcards on local parts and domain extensions (e.g. *@*.spamnetwork.com, user*@domain.com, or *.badsite.xyz).

Exact email address rules are supported on all tiers. Domain-wide and wildcard pattern rules require a Pro or Business subscription.

Configure inbound email firewall rules to allowlist trusted senders or reject unwanted addresses, full domains, and wildcard patterns at the network edge.

Quick Reference#

Endpoint	Method	Required Scope	Description
`/v1/sender-rules/whitelist`	`GET`	`sender_rules:read`	List configured allowed sender rules.
`/v1/sender-rules/whitelist`	`POST`	`sender_rules:write`	Create an allowlist rule for an address, domain, or pattern.
`/v1/sender-rules/whitelist`	`PATCH`	`sender_rules:write`	Toggle or update an allowlist rule.
`/v1/sender-rules/whitelist`	`DELETE`	`sender_rules:write`	Delete an allowlist rule.
`/v1/sender-rules/whitelist/stats`	`GET`	`sender_rules:read`	Retrieve allowlist volume and monthly trend metrics.
`/v1/sender-rules/blacklist`	`GET`	`sender_rules:read`	List configured blocked sender rules.
`/v1/sender-rules/blacklist`	`POST`	`sender_rules:write`	Create a denylist rule to reject senders or domains.
`/v1/sender-rules/blacklist`	`PATCH`	`sender_rules:write`	Toggle or update a denylist rule.
`/v1/sender-rules/blacklist`	`DELETE`	`sender_rules:write`	Delete a denylist rule.
`/v1/sender-rules/blacklist/stats`	`GET`	`sender_rules:read`	Retrieve blocked volume and monthly trend metrics.

Inbound Firewall Architecture#

The AliasFleet Inbound Firewall evaluates incoming messages at the earliest possible stage of the email delivery pipeline:

Edge Rejection: When an inbound SMTP transaction arrives from a blocked sender or domain, the firewall terminates the session during the MAIL FROM envelope handshake with an RFC 5321 550 5.7.1 permanent failure code. The message body is never accepted or stored.
Mutual Exclusivity Invariant: A sender pattern cannot exist on both your allowlist and your denylist. If you attempt to allow an address that is currently blocked, the API rejects the request with CROSS_TABLE_CONFLICT.
Pattern Matching Hierarchy:
- Exact: Matches specific email addresses (spammer@example.com).
- Domain: Matches all senders under a domain (badcompany.com), with optional recursive subdomain coverage (includeSubdomains: true).
- Pattern: Advanced wildcard matching (*@promo.*.com, alert*@monitoring.internal).

List Allowed Sender Rules#

GET /v1/sender-rules/whitelist

Returns a paginated list of allowed sender rules configured for your account.

Scope: sender_rules:readRate Limit: 60 req/minIdempotent: Yes

Query Parameters#

Parameter	Type	Required	Default	Description
`page`	`integer`	Optional	`1`	Page number for pagination.
`limit`	`integer`	Optional	`50`	Number of records per page (max `100`).
`search`	`string`	Optional	—	Case-insensitive filter on `email_pattern`.
`includeGlobal`	`boolean`	Optional	`false`	When `true`, includes platform-wide system rules alongside account rules.

Request Headers#

Header	Type	Required	Description
`Authorization`	`string`	Optional*	`Bearer afp_...`
`x-api-key`	`string`	Optional*	`afp_...` (*Provide either `Authorization` or `x-api-key`).
`Accept`	`string`	Yes	`application/json`

cURL Example#

Terminal

curl -X GET "https://api.aliasfleet.com/v1/sender-rules/whitelist?page=1&limit=2" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Accept: application/json"

Response (`200 OK`)#

JSON

{  "entries": [    {      "id": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f",      "user_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",      "email_pattern": "vip-notifications@partner.com",      "pattern_type": "exact",      "include_subdomains": false,      "reason": "Critical billing and invoice updates",      "source": "manual",      "is_active": true,      "allowed_count": 48,      "created_at": "2026-08-20T10:00:00.000Z",      "updated_at": "2026-08-20T10:00:00.000Z"    }  ],  "pagination": {    "page": 1,    "limit": 2,    "total": 1,    "totalPages": 1  }}

Response Fields#

Field	Type	Description
`entries`	`array`	List of allowlisted sender entries.
`entries[].id`	`string`	Unique rule identifier.
`entries[].user_id`	`string`	Account user ID owning this rule.
`entries[].email_pattern`	`string`	Configured address, domain, or wildcard pattern.
`entries[].pattern_type`	`string`	Matching type (`"exact"`, `"domain"`, or `"pattern"`).
`entries[].include_subdomains`	`boolean`	Whether matching applies recursively to subdomains.
`entries[].reason`	`string \| null`	Human note explaining why sender is trusted.
`entries[].source`	`string`	Rule source mechanism (`"manual"`, `"api"`).
`entries[].is_active`	`boolean`	Whether rule is actively enforced.
`entries[].allowed_count`	`integer`	Counter of messages processed via this allow rule.
`entries[].created_at`	`string`	ISO 8601 creation timestamp.
`pagination`	`object`	Page index and total items metadata.

Create Allowed Sender Rule#

POST /v1/sender-rules/whitelist

Adds a sender address, domain, or wildcard pattern to your inbound allowlist.

Scope: sender_rules:writeRate Limit: 60 req/minIdempotent: Yes

Request Body Schema#

Field	Type	Required	Constraints	Description
`emailPattern`	`string`	Yes	1–255 chars	Email (`user@domain.com`), domain (`partner.com`), or wildcard pattern (`@.corp.com`).
`patternType`	`string`	Optional	`"exact"`, `"domain"`, `"pattern"`	Pattern evaluation strategy. Defaults to `"exact"`.
`includeSubdomains`	`boolean`	Optional	Boolean	When `true` with `patternType: "domain"`, matches subdomains (e.g. `*.partner.com`).
`reason`	`string`	Optional	Max 255 chars	Contextual note explaining why the sender is allowlisted.
`source`	`string`	Optional	Max 50 chars	Origin tag: `"manual"`, `"quick_action"`, or `"api"`. Defaults to `"manual"`.

cURL Example#

Terminal

curl -X POST "https://api.aliasfleet.com/v1/sender-rules/whitelist" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Content-Type: application/json" \  -d '{    "emailPattern": "partner-network.com",    "patternType": "domain",    "includeSubdomains": true,    "reason": "Authorized B2B syndication partner"  }'

Response (`201 Created`)#

JSON

{  "success": true,  "entry": {    "id": "3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d",    "user_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",    "email_pattern": "partner-network.com",    "pattern_type": "domain",    "include_subdomains": true,    "reason": "Authorized B2B syndication partner",    "source": "manual",    "is_active": true,    "allowed_count": 0,    "created_at": "2026-09-04T12:00:00.000Z",    "updated_at": "2026-09-04T12:00:00.000Z"  },  "message": "partner-network.com has been whitelisted"}

Response Fields#

Field	Type	Description
`success`	`boolean`	Confirms rule creation.
`entry`	`object`	Newly created allowlist rule record.
`message`	`string`	User confirmation message.

Error Responses#

Status Code	Code	Error Message	Reason
`400`	`INVALID_PATTERN`	`"Please enter a valid email address."`	The `emailPattern` string is malformed or invalid syntax for the chosen `patternType`.
`402`	`ENTITLEMENT_REQUIRED`	`"Domain and wildcard pattern rules are only available on Pro and Business plans."`	Domain and wildcard pattern rules require `advanced_routing` feature access (Pro or Business plan). Returns `{ error, code: "ENTITLEMENT_REQUIRED", feature: "advanced_routing" }`.
`409`	`CROSS_TABLE_CONFLICT`	`"This pattern is already on your Blocked Senders (blacklist). A sender cannot be both allowed and blocked."`	The pattern already exists on your denylist. Remove it from the denylist first.
`409`	`ALREADY_EXISTS`	`"This sender is already whitelisted"`	The pattern is already present on your allowlist. Includes `existingId`.

Update Allowed Sender Rule#

PATCH /v1/sender-rules/whitelist

Toggles the active state or updates the description metadata for an existing allowlist rule.

Scope: sender_rules:writeRate Limit: 60 req/minIdempotent: Yes

Request Body Schema#

Field	Type	Required	Constraints	Description
`id`	`string`	Yes	Rule UUID	Unique identifier of the rule to modify.
`isActive`	`boolean`	Optional	Boolean	Activates or pauses rule enforcement.
`reason`	`string`	Optional	Max 255 chars	Updated note or rationale.
`includeSubdomains`	`boolean`	Optional	Boolean	Whether domain matching extends to subdomains.

cURL Example#

Terminal

curl -X PATCH "https://api.aliasfleet.com/v1/sender-rules/whitelist" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Content-Type: application/json" \  -d '{    "id": "3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d",    "isActive": false,    "reason": "Temporarily disabled during vendor security audit"  }'

Response (`200 OK`)#

JSON

{  "success": true,  "entry": {    "id": "3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d",    "user_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",    "email_pattern": "partner-network.com",    "pattern_type": "domain",    "include_subdomains": true,    "reason": "Temporarily disabled during vendor security audit",    "source": "manual",    "is_active": false,    "allowed_count": 12,    "created_at": "2026-09-04T12:00:00.000Z",    "updated_at": "2026-09-04T12:15:00.000Z"  }}

Response Fields#

Field	Type	Description
`success`	`boolean`	Confirms rule was updated.
`entry`	`object`	Updated allowlist record.

Error Responses#

Status Code	Code	Error Message	Reason
`400`	`NO_UPDATES`	`"No updates provided"`	Request body contains no updatable fields.
`404`	`NOT_FOUND`	`"Rule not found"`	No rule matching the provided `id` was found.

Delete Allowed Sender Rule#

DELETE /v1/sender-rules/whitelist

Permanently deletes an allowlist rule from your account.

Scope: sender_rules:writeRate Limit: 60 req/minIdempotent: Yes

Query Parameters#

Parameter	Type	Required	Description
`id`	`string`	Yes	Unique identifier (UUID) of the allowlist rule to delete passed as a query string parameter.

cURL Example#

Terminal

curl -X DELETE "https://api.aliasfleet.com/v1/sender-rules/whitelist?id=3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e"

Response (`200 OK`)#

JSON

{  "success": true,  "message": "Removed from whitelist"}

Response Fields#

Field	Type	Description
`success`	`boolean`	Confirms deletion.
`message`	`string`	Outcome status message.

Error Responses#

Status Code	Code	Error Message	Reason
`400`	`ID_REQUIRED`	`"id is required"`	The `?id=` query parameter was omitted.

Get Allowlist Metrics#

GET /v1/sender-rules/whitelist/stats

Returns aggregated statistics regarding allowlist rule counts, lifetime forwarded volumes, and monthly trends.

Scope: sender_rules:readRate Limit: 60 req/minIdempotent: Yes

cURL Example#

Terminal

curl -X GET "https://api.aliasfleet.com/v1/sender-rules/whitelist/stats" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Accept: application/json"

Response (`200 OK`)#

JSON

{  "stats": {    "totalRules": 14,    "activeRules": 12,    "rulesTrend": 20,    "totalAllowedEmails": 384,    "newThisMonth": 3  }}

Response Fields#

Field	Type	Description
`stats.totalRules`	`integer`	Total allowlist rules defined.
`stats.activeRules`	`integer`	Count of rules actively enforced.
`stats.rulesTrend`	`integer`	Month-over-month growth percentage in rules.
`stats.totalAllowedEmails`	`integer`	Total forwarded messages permitted through allowlist rules.
`stats.newThisMonth`	`integer`	Count of rules added during the current billing cycle.

List Blocked Sender Rules#

GET /v1/sender-rules/blacklist

Returns a paginated list of blocked sender rules (denylist) configured for your account.

Scope: sender_rules:readRate Limit: 60 req/minIdempotent: Yes

Query Parameters#

Parameter	Type	Required	Default	Description
`page`	`integer`	Optional	`1`	Page number for pagination.
`limit`	`integer`	Optional	`50`	Number of records per page (max `100`).
`search`	`string`	Optional	—	Case-insensitive filter on `email_pattern`.
`includeGlobal`	`boolean`	Optional	`false`	When `true`, includes platform-wide threat network rules alongside account rules.

cURL Example#

Terminal

curl -X GET "https://api.aliasfleet.com/v1/sender-rules/blacklist?page=1&limit=2" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Accept: application/json"

Response (`200 OK`)#

JSON

{  "entries": [    {      "id": "b1a2b3c4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",      "user_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",      "email_pattern": "spammer.org",      "pattern_type": "domain",      "include_subdomains": true,      "reason": "Phishing domain targeting credentials",      "source": "manual",      "is_active": true,      "blocked_count": 142,      "created_at": "2026-08-15T09:30:00.000Z",      "updated_at": "2026-08-15T09:30:00.000Z"    }  ],  "pagination": {    "page": 1,    "limit": 2,    "total": 1,    "totalPages": 1  }}

Response Fields#

Field	Type	Description
`entries`	`array`	List of blocked sender rules.
`entries[].id`	`string`	Unique rule identifier.
`entries[].user_id`	`string`	Account user ID.
`entries[].email_pattern`	`string`	Configured blocked pattern.
`entries[].pattern_type`	`string`	Mode (`"exact"`, `"domain"`, or `"pattern"`).
`entries[].include_subdomains`	`boolean`	Subdomain recursive blocking flag.
`entries[].reason`	`string \| null`	Stored note or threat classification.
`entries[].source`	`string`	Rule source mechanism.
`entries[].is_active`	`boolean`	Whether rule is actively rejecting messages.
`entries[].blocked_count`	`integer`	Count of rejected SMTP connection attempts.
`entries[].created_at`	`string`	ISO 8601 creation timestamp.
`pagination`	`object`	Page index and total items metadata.

Create Blocked Sender Rule#

POST /v1/sender-rules/blacklist

Creates an inbound denylist rule to reject messages from a specific address, domain, or wildcard pattern. Blocked messages are rejected at the edge without entering your forwarding stream.

Scope: sender_rules:writeRate Limit: 60 req/minIdempotent: Yes

Request Body Schema#

Field	Type	Required	Constraints	Description
`emailPattern`	`string`	Yes	1–255 chars	Email (`bad@spam.com`), domain (`spammer.org`), or wildcard pattern (`@.phishing.com`).
`patternType`	`string`	Optional	`"exact"`, `"domain"`, `"pattern"`	Matching mode. Auto-promoted to `domain` or `pattern` if wildcard characters are detected.
`includeSubdomains`	`boolean`	Optional	Boolean	When `true` with `patternType: "domain"`, blocks all subdomains (e.g. `*.spammer.org`).
`reason`	`string`	Optional	Max 255 chars	Rationale or internal audit comment.
`source`	`string`	Optional	Max 50 chars	Origin tag: `"manual"`, `"quick_action"`, `"automated_filter"`, or `"api"`. Defaults to `"manual"`.

cURL Example#

Terminal

curl -X POST "https://api.aliasfleet.com/v1/sender-rules/blacklist" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Content-Type: application/json" \  -d '{    "emailPattern": "scamnetwork.xyz",    "patternType": "domain",    "includeSubdomains": true,    "reason": "Persistent scam outreach campaign"  }'

Response (`201 Created`)#

JSON

{  "success": true,  "entry": {    "id": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",    "user_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",    "email_pattern": "scamnetwork.xyz",    "pattern_type": "domain",    "include_subdomains": true,    "reason": "Persistent scam outreach campaign",    "source": "manual",    "is_active": true,    "blocked_count": 0,    "created_at": "2026-09-04T12:00:00.000Z",    "updated_at": "2026-09-04T12:00:00.000Z"  },  "message": "scamnetwork.xyz has been blacklisted"}

Response Fields#

Field	Type	Description
`success`	`boolean`	Confirms denylist rule creation.
`entry`	`object`	Newly registered blocked sender rule.
`message`	`string`	Outcome status message.

Error Responses#

Status Code	Code	Error Message	Reason
`400`	`INVALID_PATTERN`	`"Please enter a valid domain name (e.g. spammer.com)."`	The pattern syntax does not conform to RFC email or hostname specifications.
`402`	`ENTITLEMENT_REQUIRED`	`"Domain and wildcard pattern rules are only available on Pro and Business plans."`	Domain and wildcard pattern rules require `advanced_routing` feature access (Pro or Business subscription). Returns `{ error, code: "ENTITLEMENT_REQUIRED", feature: "advanced_routing" }`.
`409`	`CROSS_TABLE_CONFLICT`	`"This pattern is already on your Allowed Senders (whitelist). A sender cannot be both allowed and blocked."`	Pattern already exists on your allowlist. Remove it from the allowlist first.
`409`	`ALREADY_EXISTS`	`"This sender is already blacklisted"`	Pattern is already present in your denylist. Includes `existingId`.

Update Blocked Sender Rule#

PATCH /v1/sender-rules/blacklist

Updates an existing blocked sender rule, allowing you to toggle rule enforcement on or off without deleting the rule history and counters.

Scope: sender_rules:writeRate Limit: 60 req/minIdempotent: Yes

Request Body Schema#

Field	Type	Required	Constraints	Description
`id`	`string`	Yes	Rule UUID	Unique identifier of the denylist rule to modify.
`isActive`	`boolean`	Optional	Boolean	Activates or pauses rule enforcement.
`reason`	`string`	Optional	Max 255 chars	Updated note or rationale.
`includeSubdomains`	`boolean`	Optional	Boolean	Whether domain matching extends to subdomains.

cURL Example#

Terminal

curl -X PATCH "https://api.aliasfleet.com/v1/sender-rules/blacklist" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Content-Type: application/json" \  -d '{    "id": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",    "isActive": false,    "reason": "Deactivated pending review of false positive"  }'

Response (`200 OK`)#

JSON

{  "success": true,  "entry": {    "id": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",    "user_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",    "email_pattern": "scamnetwork.xyz",    "pattern_type": "domain",    "include_subdomains": true,    "reason": "Deactivated pending review of false positive",    "source": "manual",    "is_active": false,    "blocked_count": 27,    "created_at": "2026-09-04T12:00:00.000Z",    "updated_at": "2026-09-04T12:20:00.000Z"  }}

Response Fields#

Field	Type	Description
`success`	`boolean`	Confirms rule was updated.
`entry`	`object`	Updated denylist record.

Error Responses#

Status Code	Code	Error Message	Reason
`400`	`NO_UPDATES`	`"No updates provided"`	Request body contains no updatable fields.
`404`	`NOT_FOUND`	`"Rule not found"`	No rule matching the provided `id` was found.

Delete Blocked Sender Rule#

DELETE /v1/sender-rules/blacklist

Permanently deletes a blocked sender rule from your account. Messages from the sender will once again be evaluated according to standard forwarding rules.

Scope: sender_rules:writeRate Limit: 60 req/minIdempotent: Yes

Query Parameters#

Parameter	Type	Required	Description
`id`	`string`	Yes	Unique identifier (UUID) of the denylist rule to delete passed as a query string parameter.

cURL Example#

Terminal

curl -X DELETE "https://api.aliasfleet.com/v1/sender-rules/blacklist?id=e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e"

Response (`200 OK`)#

JSON

{  "success": true,  "message": "Removed from blacklist"}

Response Fields#

Field	Type	Description
`success`	`boolean`	Confirms rule was deleted.
`message`	`string`	Outcome status message.

Error Responses#

Status Code	Code	Error Message	Reason
`400`	`ID_REQUIRED`	`"id is required"`	The `?id=` query parameter was omitted.

Get Denylist Metrics#

GET /v1/sender-rules/blacklist/stats

Returns aggregated statistics regarding blocked sender rules, lifetime rejected messages, and month-over-month threat volume trends.

Scope: sender_rules:readRate Limit: 60 req/minIdempotent: Yes

cURL Example#

Terminal

curl -X GET "https://api.aliasfleet.com/v1/sender-rules/blacklist/stats" \  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \  -H "Accept: application/json"

Response (`200 OK`)#

JSON

{  "total": 35,  "active": 32,  "totalBlocked": 1842,  "newThisMonth": 6,  "newLastMonth": 4,  "blacklistTrend": 50,  "blockedTrend": -12,  "blockedThisMonth": 210,  "blockedLastMonth": 238}

Response Fields#

Field	Type	Description
`total`	`integer`	Total denylist rules configured.
`active`	`integer`	Count of rules actively blocking incoming mail.
`totalBlocked`	`integer`	Total inbound SMTP connection handshakes terminated by denylist rules.
`newThisMonth`	`integer`	Count of rules added during the active billing period.
`newLastMonth`	`integer`	Count of rules added during previous cycle.
`blacklistTrend`	`integer`	Percentage increase or decrease in rules.
`blockedTrend`	`integer`	Percentage change in blocked volume compared to previous cycle.
`blockedThisMonth`	`integer`	Total emails dropped during current billing period.
`blockedLastMonth`	`integer`	Total emails dropped during prior billing period.

Quick Reference#

Inbound Firewall Architecture#

List Allowed Sender Rules#

Query Parameters#

Request Headers#

cURL Example#

Response (200 OK)#

Response Fields#

Create Allowed Sender Rule#

Request Body Schema#

cURL Example#

Response (201 Created)#

Response Fields#

Error Responses#

Update Allowed Sender Rule#

Request Body Schema#

cURL Example#

Response (200 OK)#

Response Fields#

Error Responses#

Delete Allowed Sender Rule#

Query Parameters#

cURL Example#

Response (200 OK)#

Response Fields#

Error Responses#

Get Allowlist Metrics#

cURL Example#

Response (200 OK)#

Response Fields#

List Blocked Sender Rules#

Query Parameters#

cURL Example#

Response (200 OK)#

Response Fields#

Create Blocked Sender Rule#

Request Body Schema#

cURL Example#

Response (201 Created)#

Response Fields#

Error Responses#

Update Blocked Sender Rule#

Request Body Schema#

cURL Example#

Response (200 OK)#

Response Fields#

Error Responses#

Delete Blocked Sender Rule#

Query Parameters#

cURL Example#

Response (200 OK)#

Response Fields#

Error Responses#

Get Denylist Metrics#

cURL Example#

Response (200 OK)#

Response Fields#

Frequently Asked Questions

Can a sender exist on both the allowlist and the denylist?

How fast are newly created rules enforced on incoming emails?

What wildcard pattern formats are supported?

Are wildcard and domain rules available on all plans?

Was this article helpful?

Related in Developer API

Identity & Token Introspection API

Aliases API

Alias Destinations & Batch Operations API

Domains API

Destinations API

Still need help?

Quick Reference#

Inbound Firewall Architecture#

List Allowed Sender Rules#

Query Parameters#

Request Headers#

cURL Example#

Response (200 OK)#

Response Fields#

Create Allowed Sender Rule#

Request Body Schema#

Response (`200 OK`)#

Response (`201 Created`)#

Response (`200 OK`)#

Response (`200 OK`)#

Response (`200 OK`)#

Response (`200 OK`)#

Response (`201 Created`)#

Response (`200 OK`)#

Response (`200 OK`)#

Response (`200 OK`)#

Response (`200 OK`)#

Response (`201 Created`)#

Response (`200 OK`)#

Response (`200 OK`)#