Skip to main content
POST
/
orgs
/
{org_id}
/
allowed-emails
Add Allowed Emails
curl --request POST \
  --url https://api.example.com/orgs/{org_id}/allowed-emails \
  --header 'Content-Type: application/json' \
  --data '
{
  "emails": [
    "jsmith@example.com"
  ]
}
'
{
  "added": 123,
  "duplicates_skipped": 123
}

Headers

authorization
string | null

Path Parameters

org_id
string
required

Body

application/json

Request model for adding emails to the allowlist.

emails
string<email>[]
required

Email addresses to allow

Minimum array length: 1

Response

Successful Response

Response for POST /orgs/{org_id}/allowed-emails.

added
integer
required

Number of emails added

duplicates_skipped
integer
required

Number of duplicates skipped