Channel Developers

thumbnail

Get a single Campaign User

Get a particular Campaign User object

Accessible via URL https://api.channel.io/open/v5/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

GET https://api.channel.io/open/v5/mkt/campaigns/1234/campaign-users/5ec3a01fe2b3f4d2cbc5

Returns a Campaign User object along with related information

JSON

Campaign User object is specified by a pair of campaignId and userId. userId field is ID of User object, not Campaign User object. Campaign User object doesn't have unique ID field.

The Campaign User is a target of the unify process. In other words, the Campaign 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.