Get a single Campaign User
Get a particular Campaign User
object
Parameter
Accessible via URL https://api.channel.io/open/v4/mkt/campaigns/{campaignId}/campaign-users/{userId}
and HTTP GET
Parameter | Example | Required | Description | Parameter Type |
---|---|---|---|---|
campaignId | 1234 | Required | ID of Campaign object | Path |
userId | 5ec3a01fe2b3f4d2cbc5 | Required | ID of User object | Path |
Example
GET https://api.channel.io/open/v4/mkt/campaigns/1234/campaign-users/5ec3a01fe2b3f4d2cbc5
Response
Returns a Campaign User
object along with related information
{
"campaignUser": {
"campaignId": "string",
"userId": "string",
"msgId": "string",
"sent": 1624422341382,
"view": 1624422341385,
"goal": 1624422341386,
"click": 1624422341386,
"version": 0,
"id": "string"
}
}
Implementation Note
Campaign User
object is specified by a pair ofcampaignId
anduserId
.userId
field is ID ofUser
object, notCampaign User
object.Campaign User
object doesn't have unique ID field.
The
Campaign User
is a target of the unify process. In other words, theCampaign User
data will be unified if one is logged in afterwards.
The
Campaign User
objects who has been updated more than a year ago will not be retrieved.
Updated 11 months ago