Skip to main content
POST
apps.action.choices

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-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
ref
string
required

The ref returned by apps.actions.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
field
string
required

Field key returned by apps.action.fields.

Required string length: 1 - 128
connectionAlias
string

Name of a connection configured with your account, never an upstream identifier. Omit when exactly one eligible connection exists.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9_-]+$
input
object

App arguments; may contain personal data. Maximum 100 KB.

limit
number

Page size, at most 50; default 10.

Required range: x >= 1
cursor
string

Opaque cursor from the previous page.

Required string length: 1 - 2048

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.