campaign.member.remove

The campaign.member.remove command is used to remove things from a campaign.

TR50 Request


                            {
  "cmd": {
    "command": "campaign.member.remove",
    "params": {
      "campaignId": "537a3fa6d15a702de0000007",
      "id": ["537a3fa6d15a702de00abcd1", "537a3fa6d15a702de00abcd3"]
    }
  }
}

Request Parameters


Name	Type	Required	Description
campaignId	String	Yes	The unique identifier of the campaign.
id	Array	Yes	One or more task ID values, representing the members of the campaign to remove.

TR50 Response

If the command is sent successfully a success message is returned. Otherwise, an error and error message will be returned.


                            {
  "cmd": {
    "success": true,
    "params": {
      "good": 2,
      "bad": 0
    }
  }
}

Response Parameters


Name	Type	Description
good	Integer	The number of requested task IDs that were successfully removed from the campaign.
bad	Integer	The number of requested task IDs that failed to be removed from the campaign.