{"__v":1,"_id":"5840b49b63e13523002d0244","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":14,"_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"],"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":"2016-12-01T23:39:07.041Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"5840b49b63e13523002d0246","ref":"","in":"body","required":false,"desc":"Arbitrary name to give to the rule that will show up in https://app.mixmax.com/dashboard/rules","default":"","type":"string","name":"name"},{"_id":"5840b49b63e13523002d0245","ref":"","in":"body","required":true,"desc":"Event name","default":"","type":"string","name":"eventName"},{"_id":"5840cfaec6c9322300274014","ref":"","in":"body","required":false,"desc":"The Sift filter object, run through JSON.stringify","default":"","type":"string","name":"filter"},{"_id":"5840cfaec6c9322300274013","ref":"","in":"body","required":true,"desc":"The action object","default":"","type":"object","name":"action"}],"url":"/v1/rules"},"isReference":true,"order":50,"body":"See [/rules](http://developer.mixmax.com/docs/rules) for format.\n\nNote that depending on the complexity of your rule filter, the Mixmax UI (https://app.mixmax.com/dashboard/rules) might not be able to edit it. Assume that rules you create using this API won't be editable in the UI.","excerpt":"Creates a Mixmax Rule","slug":"rules-1","type":"post","title":"/rules"}

post/rules

Creates a Mixmax Rule

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

name:
string
Arbitrary name to give to the rule that will show up in https://app.mixmax.com/dashboard/rules
eventName:
required
string
Event name
filter:
string
The Sift filter object, run through JSON.stringify
action:
required
object
The action object

Documentation

See [/rules](http://developer.mixmax.com/docs/rules) for format. Note that depending on the complexity of your rule filter, the Mixmax UI (https://app.mixmax.com/dashboard/rules) might not be able to edit it. Assume that rules you create using this API won't be editable in the UI.

User Information

Try It Out

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