Update a rule - Rules - API Reference

PUT

/v3/rules/{rule_id}

Updates the specified rule. All fields are optional — only provided fields are updated. The same validation rules apply as on create.

NYLAS API KEY

Parameters

Path parameters

rule_id*string

The ID of the rule to access.

Request body

namestring

Example: "Block spam domains (updated)"

descriptionstring

priorityinteger

min: 0max: 1000

enabledboolean

triggerstring

The trigger the rule listens for. Inbound rules accept only from.* conditions. Outbound rules accept from.*, recipient.*, and outbound.type.

inboundoutbound

matchobject

actionsarray<object>

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/rules/<RULE_ID>" \
  -H "Authorization: Bearer <NYLAS_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": false
  }'
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 ruleBeta

Parameters

Path parameters

Request body

Responses