POST
/
api
/
v2
/
apps
/
{app}
/
choices
/
{prefill}
/
Get Prefill Choices
curl --request POST \
  --url https://actions.zapier.com/api/v2/apps/{app}/choices/{prefill}/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "params": {}
}'
{
  "is_loading": true,
  "last_refresh_seconds_ago": 123,
  "results": [
    {
      "key": "<string>",
      "label": "<string>",
      "sample": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
app
string
required

The app that the prefill belongs to.

​
prefill
string
required

The prefill to get choices for.

Query Parameters

​
authentication_id
integer | null

ID of the authentication to use for the app.

Authentications available to the user can be listed using the List Authentications For App endpoint.

​
account_id
integer

The Zapier account ID to use.

Account IDs available to the user can be listed using the Get Account List endpoint

​
query
string | null

Optional query to filter results by.

​
force_refresh
boolean
default:false

The list of prefill options for each user/app/prefill combo is cached for 24 hours.

If force_refresh is set to true, the cache will be refreshed. This should only be used when the list of prefill options is known to have changed.

Best practice is to offer a "Refresh" button to the user that sets this to true for one request.

Body

application/json
​
params
object
required

A dictionary of key-value pairs, where the key is a need key and the value is a selected value for that need.

Response

200 - application/json

OK

​
is_loading
boolean
required

If this is true, then it means that the list of prefill options is still being loaded.

While this is true, the endpoint should be polled (in general every second) until it returns false.

​
last_refresh_seconds_ago
integer | null
required

Seconds that have elapsed since the list of options for this prefill has been refreshed.

To refresh the list, use the force_refresh query parameter.

​
results
ChoiceT · object[]
required