Skip to main content
GET
/
v1
/
admin
/
notifications
/
recipients
Error
A valid request URL is required to generate request examples
{
  "recipients": 123,
  "capped": true
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

​
aura_session
string
cookie
required

HttpOnly session cookie set by POST /v1/auth/session. Mutating requests must also send the CSRF token (returned by that call) in the x-csrf-token header.

Query Parameters

​
audience
enum<string>
required
Available options:
all,
market_holders
​
marketAddress
string

Alephium address (base58, optional :N group suffix).

Required string length: 30 - 80
Pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz:]+$
​
side
enum<string>
Available options:
yes,
no

Response

Default Response

​
audience
enum<string>
required
Available options:
all,
market_holders
​
recipients
number
required
​
capped
boolean
required