GET /api/admin/bounce/v1

Note

This page was generated by extracting information from a JSON Schema data file for the API. It may be missing some information, or otherwise suggest approximate or placeholder values based on information in the schema file; this is due to limitations on how that data is extracted from the underlying Rust code and into the JSON Schema, and then again from there and into these docs.

Allows the system operator to list all currently active administrative bounces that have been configured.

Responses

Status 200

Returned information about current admin bounces

Content-Type: application/json

This is an array of type BounceV1ListEntry. There are no constraints on the size of the array.

Examples

[
  {
    "bounced": {
      "gmail.com": 200,
      "yahoo.com": 100
    },
    "campaign": "campaign_name",
    "domain": "example.com",
    "duration": "string",
    "id": "552016f1-08e7-4e90-9da3-fd5c25acd069",
    "reason": "cleaning up a bad send",
    "routing_domain": "routing_domain.com",
    "tenant": "tenant_name",
    "total_bounced": 42
  }
]