{"_id":"5a3976962e4b15002a702f42","project":"5588b8a2f6c18d0d005bba03","version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":16,"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","5a31c9409a6f2000125c079f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"57f53fb368a53b2000e03f0f","version":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API: Access your Mixmax data"},"user":"5588b847f6c18d0d005bba01","githubsync":"","__v":6,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-12-19T20:29:10.072Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"5a3976962e4b15002a702f43","ref":"","in":"body","required":true,"desc":"The type of action. These currently aren't listed in the document, so if you'd like to create one, use the Mixmax Rules UI and then use the GET API to figure out its type.","default":"","type":"string","name":"type"},{"_id":"5a3981050f316400120449c9","ref":"","in":"body","required":false,"desc":"True to pause this rule action. It will not run, but will continue to show up in the UI","default":"false","type":"boolean","name":"isPaused"},{"_id":"5a3984160f31640012044a05","ref":"","in":"path","required":true,"desc":"The _id of the rule","default":"","type":"string","name":"id"}],"url":"/v1/rules/:id/actions"},"isReference":true,"order":84,"body":"Note that you may also pass other arbitrary properties that are specific to this `type` of rule action.","excerpt":"Creates a new rule action","slug":"rulesidactions","type":"endpoint","title":"/rules/:id/actions"}

post/rules/:id/actions

Creates a new rule action

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The _id of the rule

Body Params

type:
required
string
The type of action. These currently aren't listed in the document, so if you'd like to create one, use the Mixmax Rules UI and then use the GET API to figure out its type.
isPaused:
booleanfalse
True to pause this rule action. It will not run, but will continue to show up in the UI

Documentation

Note that you may also pass other arbitrary properties that are specific to this `type` of rule action.

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 }}