Skip to main content
POST
/
v1
/
apps
/
{app_id}
/
allowlist
Add to allowlist
curl --request POST \
  --url https://api.privy.io/v1/apps/{app_id}/allowlist \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'privy-app-id: <privy-app-id>' \
  --data '
{
  "type": "email",
  "value": "[email protected]"
}
'
{
  "id": "abc123",
  "type": "email",
  "value": "[email protected]",
  "appId": "clxyz456",
  "acceptedAt": null
}

​
SDK methods

Learn more about managing your allowlist using our SDKs here.

Authorizations

​
Authorization
string
header
required

Basic Auth header with your app ID as the username and your app secret as the password.

Headers

​
privy-app-id
string
required

ID of your Privy app.

Path Parameters

​
app_id
string
required

The ID of the app.

Body

application/json

Allowlist invite input for an email address.

​
type
enum<string>
required
Available options:
email
​
value
string<email>
required

Response

200 - application/json

The created allowlist entry.

An allowlist entry for an app.

​
id
string
required
​
type
string
required
​
value
string
required
​
appId
string
required
​
acceptedAt
number | null
required