Skip to content

XferCancelV1Request

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.

This is an object value, with the following properties:

  • queue_name - required string. The name of the xfer scheduled queue

  • reason - required string. Reason to log in the delivery log. Each matching message will log with an AdminRebind record to indicate that it was moved from its containing queue, and this reason will be included in that record.

Examples

{
  "queue_name": "string",
  "reason": "Scaling down"
}