{"_id":"59cc39992b5844002810802b","project":"5588b8a2f6c18d0d005bba03","version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":15,"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"},"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"},"user":"5588b847f6c18d0d005bba01","__v":2,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-27T23:51:53.417Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"name":"","code":"{\n  recipients: ['foo:::at:::mixmax.com', 'bar@mixmax.com']\n}","language":"json"}]},"method":"post","examples":{"codes":[]},"auth":"required","params":[{"_id":"58c83145942dc81b00657ba1","ref":"","in":"body","required":false,"desc":"If provided, it will cancel only recipients matching these emails in the sequence. Otherwise, it will cancel ALL active recipients in the sequence.","default":"","type":"array_string","name":"emails"}],"url":"/v1/sequences/cancel"},"isReference":true,"order":108,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"See [Incoming Webhooks](http://success.mixmax.com/article/205-incoming-webhooks) that allow you to easily cancel a sequence recipient without writing code\",\n  \"title\": \"Have you seen Incoming Webhooks?\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Response structure\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"recipients\",\n    \"0-1\": \"String[]\",\n    \"0-2\": \"The list of recipient email addresses that were cancelled in the sequence.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]","excerpt":"Cancels all active recipients from all sequences (or just `emails` if passed)","slug":"sequencescancel","type":"endpoint","title":"/sequences/cancel"}

post/sequences/cancel

Cancels all active recipients from all sequences (or just `emails` if passed)

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

emails:
array of strings
If provided, it will cancel only recipients matching these emails in the sequence. Otherwise, it will cancel ALL active recipients in the sequence.

Result Format


Documentation

[block:callout] { "type": "info", "body": "See [Incoming Webhooks](http://success.mixmax.com/article/205-incoming-webhooks) that allow you to easily cancel a sequence recipient without writing code", "title": "Have you seen Incoming Webhooks?" } [/block] [block:api-header] { "title": "Response structure" } [/block] [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "recipients", "0-1": "String[]", "0-2": "The list of recipient email addresses that were cancelled in the sequence." }, "cols": 3, "rows": 1 } [/block]

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