{"__v":1,"_id":"58803c62d7520f0f0064c2a7","category":{"__v":0,"_id":"57f53fb368a53b2000e03f0f","project":"5588b8a2f6c18d0d005bba03","version":"5588b8a2f6c18d0d005bba06","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API"},"parentDoc":null,"project":"5588b8a2f6c18d0d005bba03","user":"5588b847f6c18d0d005bba01","version":{"__v":15,"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b","58db348aa32c8419002433bb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-01-19T04:11:14.052Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"patch","results":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"58803c62d7520f0f0064c2ac","ref":"","in":"body","required":false,"desc":"Name of the rule","default":"","type":"string","name":"name"},{"_id":"58803c62d7520f0f0064c2ab","ref":"","in":"body","required":false,"desc":"Must be valid event name in http://developer.mixmax.com/docs/rules","default":"","type":"string","name":"eventName"},{"_id":"58803c62d7520f0f0064c2aa","ref":"","in":"body","required":false,"desc":"See http://developer.mixmax.com/docs/rules for Sift object format","default":"","type":"object","name":"filter"},{"_id":"58803c62d7520f0f0064c2a9","ref":"","in":"body","required":false,"desc":"Valid action in http://developer.mixmax.com/docs/rules","default":"","type":"object","name":"action"},{"_id":"58803c62d7520f0f0064c2a8","ref":"","in":"body","required":false,"desc":"True if this action should NOT process events","default":"false","type":"boolean","name":"isPaused"},{"_id":"58803ca6b3e2af0f003b6a5d","ref":"","in":"path","required":true,"desc":"_id of the rule to update","default":"","type":"string","name":"id"}],"url":"/v1/rules/:id"},"isReference":true,"order":67,"body":"","excerpt":"Updates a rule","slug":"rulesid-1","type":"endpoint","title":"/rules/:id"}

patch/rules/:id

Updates a rule

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
_id of the rule to update

Body Params

name:
string
Name of the rule
eventName:
string
Must be valid event name in http://developer.mixmax.com/docs/rules
filter:
object
See http://developer.mixmax.com/docs/rules for Sift object format
action:
object
Valid action in http://developer.mixmax.com/docs/rules
isPaused:
booleanfalse
True if this action should NOT process events

User Information

Try It Out

patch
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}