Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
amount
string

Payout amount

currency
enum<string>

Currency

Available options:
USD,
EUR,
GBP,
JPY,
INR,
CAD,
AUD,
BRL,
MXN,
NGN,
ZAR,
PHP,
TRY,
NONE
headline
string

Notification title

body
string

Notification message

wallpaper
enum<string>

Wallpaper

Available options:
abstract,
aurora,
sunset,
midnight,
ocean,
forest,
charcoal
customWallpaper
string

Custom wallpaper

style
enum<string>

Notification style

Available options:
light,
dark
appName
string

App name

timeAgo
string

Notification age

carrier
string

Carrier

clock
string

Clock

lockDate
string

Date

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.