Create a policy - Policies - API Reference

POST

/v3/policies

Creates a policy for your application. Policies define message limits, spam detection settings, options, and linked rules for Nylas Agent Accounts. The application_id and organization_id are derived from your API key, so you don't need to include them in the request body — they are read-only.

NYLAS API KEY

Request body

name*string

A human-readable name for the policy.

Example: "Standard Agent Account Policy"

optionsobject

limitsobject

rulesarray<string>

Rule IDs to link to this policy.

Example: ["c1d2e3f4-5678-4abc-9def-0123456789ab"]

spam_detectionobject

Responses

request_idstring

ID of the request.

Example: "5fa64c92-e840-4357-86b9-2aa364d35b88"

dataobject

curl -X POST "https://api.us.nylas.com/v3/policies" \ -H "Authorization: Bearer <NYLAS_API_KEY>" \ -H "Content-Type: application/json" \ -d '{ "name": "Standard Agent Account Policy", "spam_detection": { "use_list_dnsbl": true, "use_header_anomaly_detection": true, "spam_sensitivity": 1.5 }, "limits": { "limit_attachment_size_limit": 26214400, "limit_attachment_count_limit": 50, "limit_inbox_retention_period": 365, "limit_spam_retention_period": 30 } }'

Create a policyBeta

Request body

Responses