Skip to main content
POST
messaging.opt-outs.list

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
limit
integer

How many entries to return, 1 to 100. Default 50.

Required range: 1 <= x <= 100
cursor
string

nextCursor from the previous page.

Maximum string length: 64

Response

The result

results
object[]
required

Your project's own entries, oldest first.

nextCursor
string

Pass as cursor for the next page.