Update a policy - Policies - API Reference

PUT

/v3/policies/{policy_id}

Updates the specified policy. All fields are optional — only provided fields are updated. The same plan-limit, spam sensitivity, and retention-period validation applies as on create.

NYLAS API KEY

Parameters

Path parameters

policy_id*string

The ID of the policy to access.

Request body

namestring

Example: "Updated policy name"

optionsobject

limitsobject

rulesarray<string>

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

spam_detectionobject

Responses

request_idstring

ID of the request.

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

dataobject

Code examples

curl -X PUT "https://api.us.nylas.com/v3/policies/<POLICY_ID>" \
  -H "Authorization: Bearer <NYLAS_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "rules": ["<RULE_ID_1>", "<RULE_ID_2>"]
  }'
Sign in and select an app and grant, then add any required auth token, to auto-fill these placeholders with your real values.

Copy

View as Markdown

Install

Open in

Open in Claude Open in ChatGPT Open in Cursor

Previous Next

Update a policyBeta

Parameters

Path parameters

Request body

Responses