agent-policy

Agent Policies

Detailed reference for nylas agent policy.

Policies are application-level resources backed by /v3/policies. They attach to workspaces via policy_id.

Commands

nylas agent policy list
nylas agent policy create --name "Strict Policy"
nylas agent policy create --data-file policy.json
nylas agent policy get <policy-id>
nylas agent policy read <policy-id>
nylas agent policy update <policy-id> --name "Updated Policy"
nylas agent policy update <policy-id> --data-file update.json
nylas agent policy delete <policy-id> --yes

Listing Policies

nylas agent policy list
nylas agent policy list --json

Lists all policies from /v3/policies. Text output shows which workspace has each policy attached.

Reading Policies

nylas agent policy get <policy-id>
nylas agent policy read <policy-id>
nylas agent policy read <policy-id> --json

Notes:

• get and read are aliases
• text output expands the policy into readable sections for:
  • rules
  • limits
  • options
  • spam detection
• --json returns the raw API payload

Use --json when you need the exact field names for automation or a follow-up update.

Creating Policies

Simple Create

nylas agent policy create --name "Strict Policy"
nylas agent policy create --name "Strict Policy" --json

This is the fastest path when you only need a named policy object and will add rules or settings later.

Full JSON Create

nylas agent policy create --data-file policy.json
nylas agent policy create --data '{"name":"Strict Policy","rules":["rule-123"]}'

Every limit is optional: omitted limits default to your billing plan's maximum, and values above the plan maximum are rejected by the API.

Example payload:

{
  "name": "Strict Policy",
  "rules": ["rule-123"],
  "limits": {
    "limit_attachment_size_limit": 50480000,
    "limit_attachment_count_limit": 10,
    "limit_count_daily_message_per_grant": 500,
    "limit_inbox_retention_period": 30,
    "limit_spam_retention_period": 7
  },
  "spam_detection": {
    "use_list_dnsbl": false,
    "use_header_anomaly_detection": false,
    "spam_sensitivity": 1
  }
}