Skip to content

Automation: Add user(s) to campaign

Availability

Available as of March 1st, 2021. Version 2.9.0

Protocol

POST

URL

https://(subdomain).helpmonks.com/api/v1/engage/campaign/auto/user/add

Parameters

Name Required Value Comment
campaign_id Yes ID of the campaign String
user_id Yes/No ID of the user to add String
user_ids Yes/No An array ID's of users String

Important Note

Use “user_id” to add one user or “user_ids” to add multiple users to a campaign.

Example

{
    "campaign_id" : "934875p9o4j5p9095ul4k5j",
    "user_id" : "73958uk2hyuiy234857"
}

or

{
    "campaign_id" : "934875p9o4j5p9095ul4k5j",
    "user_ids" : [ "73958uk2hyuiy234857", "jsadhfki8798798das7f98" ]
}