Get a single OneTimeMsg User

Get a particular OneTimeMsg User object

Parameter

Accessible via URL https://api.channel.io/open/v4/mkt/one-time-msgs/{oneTimeMsgId}/one-time-msg-users/{userId} and HTTP GET

Parameter

Example

Required

Description

Parameter Type

oneTimeMsgId

1234

Required

ID of OneTimeMsg object

Path

userId

5ec3a01fe2b3f4d2cbc5

Required

ID of User object

Path

Example

GET https://api.channel.io/open/v4/mkt/one-time-msgs/1234/one-time-msg-users/5ec3a01fe2b3f4d2cbc5

Response

Returns a OneTimeMsg User object along with related information

{
  "oneTimeMsgUser": {
    "oneTimeMsgId": "string",
    "userId": "string",
    "sent": 1624422348988,
    "view": 1624422348989,
    "goal": 1624422348989,
    "click": 1624422348989,
    "version": 0,
    "id": "string"
  }
}

Implementation Note

❗️

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

🚧

The OneTimeMsg User is not a target of the unify process. In other words, the OneTimeMsg User data would not be unified even if one is logged in afterwards.

🚧

The OneTimeMsg User objects who has been updated more than a year ago will not be retrieved.