ROOKDocs
Sign In
POST

Create a monitoring queue

ENDPOINT/v1/monitoring/queues

Creates a work queue with a name, optional description, default assignee, and routing rules. name is unique per program. Send Idempotency-Key so retries return the original queue. This operation is program-scoped.

Authentication & Headers

HeaderTypeRequirementDescription
AuthorizationstringREQUIREDAPI key passed as an HTTP Bearer token: Bearer rk_live_...
X-Program-IDUUIDPROGRAM-SCOPEDProgram boundary UUID that scopes the issuing card, wallet, or transfer.
Content-TypestringREQUIREDMust be application/json.
Idempotency-KeystringOPTIONALUnique UUID to prevent duplicate execution of financial creations or mutations.

Request Body Schema

application/json
namestring
REQUIRED

Display name. Unique per program.

descriptionstringnull
optional

Operator-facing summary of this queue.

default_assignee_idstringnulluuid
optional

Operator assigned to matching cases at open. Null leaves cases unassigned.

rulesarray
optional

Routing conditions. A case matches when every rule matches (logical AND). An empty list matches every unrouted case.

Properties of rules
attributestringrequired
Case field the routing rule compares. `RISK_SCORE` is an integer 0–100. `WALLET_ID` is a UUID. The others are closed enums on the case.
operationstringrequired
Comparison applied to `attribute`. `IS_ONE_OF` and `IS_NOT_ONE_OF` take a string array. `IS_GREATER_THAN` and `IS_LESS_THAN` take an integer and apply to `RISK_SCORE`.
valueanyrequired
Right-hand side of the routing rule. Shape follows `operation`: a string array for `IS_ONE_OF` / `IS_NOT_ONE_OF`, and an integer for `IS_GREATER_THAN` / `IS_LESS_THAN`.

Response Codes & Schemas

201The queue was created.
application/json
{
  "id": "6a8d1e30-5b2c-4f47-9d0e-3c4f5a6b7182",
  "object": "monitoring_queue",
  "name": "First-line fraud",
  "description": "High-priority fraud cases from rule and score triggers.",
  "default_assignee_id": "7b9e2f41-6c3d-4058-ae1f-4d5a6b7c8293",
  "rules": [
    {
      "attribute": "CATEGORY",
      "operation": "IS_ONE_OF",
      "value": [
        "FRAUD"
      ]
    },
    {
      "attribute": "PRIORITY",
      "operation": "IS_ONE_OF",
      "value": [
        "HIGH",
        "CRITICAL"
      ]
    },
    {
      "attribute": "RISK_SCORE",
      "operation": "IS_GREATER_THAN",
      "value": 70
    }
  ],
  "created_at": "2026-08-12T09:00:00Z",
  "updated_at": "2026-08-12T09:00:00Z"
}
400Bad Request: malformed JSON, failed schema validation, or conflicting parameters.
application/json
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "invalid order by: foo. Valid options are: [created_at updated_at]",
    "param": "order_by",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/invalid_request"
  }
}
401Unauthorized: missing, malformed, or unknown API key.
application/json
{
  "error": {
    "type": "authentication_error",
    "code": "authentication_error",
    "message": "A valid API key is required.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/authentication_error"
  }
}
403Forbidden: the API key is denied by RBAC, or it cannot access this program. A resource that exists on another program or organization returns `404 not_found`, not `403`.
application/json
{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The API key cannot access this program.",
    "param": "X-Program-ID",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/permission_denied"
  }
}
404Not Found: unknown id, or the resource is not visible to this API key.
application/json
{
  "error": {
    "type": "not_found_error",
    "code": "not_found",
    "message": "No card found for the given id.",
    "param": "card_id",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/not_found"
  }
}
409Conflict: incompatible state, or Idempotency-Key reused with a different body.
application/json
{
  "error": {
    "type": "conflict_error",
    "code": "conflict",
    "message": "The card cannot be reissued from its current state.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/conflict"
  }
}
422Unprocessable Entity: the document is valid JSON but violates a business rule.
application/json
{
  "error": {
    "type": "invalid_request_error",
    "code": "insufficient_funds",
    "message": "The source financial account does not have enough available balance.",
    "param": "amount",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/insufficient_funds"
  }
}
429Too Many Requests: the API key exceeded its rate limit.
application/json
{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/rate_limited"
  }
}
500Internal Server Error: unexpected failure. Retry with the same Idempotency-Key.
application/json
{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred. Retry with the same Idempotency-Key.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/internal_error"
  }
}