Automation: Remove user(s) from distribution list
Availability
Available as of March 1st, 2021. Version 2.9.0
Protocol
POST
URL
https://(subdomain).helpmonks.com/api/v1/engage/campaign/list/user/remove
Parameters
Name | Required | Value | Comment |
---|---|---|---|
list_id | Yes | ID of the distribution list | String |
user_id | Yes/No | ID of the user to add | String |
user_ids | Yes/No | An array ID's of users | Array |
Important Note
Use “user_id” to remove one user or “user_ids” to remove multiple users from a distribution list.
Example
{
"list_id" : "934875p9o4j5p9095ul4k5j",
"user_id" : "73958uk2hyuiy234857"
}
or
{
"list_id" : "934875p9o4j5p9095ul4k5j",
"user_ids" : [ "73958uk2hyuiy234857", "jsadhfki8798798das7f98" ]
}