GuidesRecipesAPI Reference
API Reference
Log inHelp centre

Omnichannel Profile Events

🚧

Please note these events only apply to changes to an Omnichannel API profile and not a Dotdigital contact.

Create

Example

{
    "eventId": "ef21e48a-44ab-45a5-b0df-d69efefd84f4",
    "accountId": 1234,
    "apiSpaceId": "fe11e8af-5fc3-40d4-a38c-034535c0a385",
    "name": "profile.create",
    "payload": {
        "id": "[email protected]",
        "fbMessengerId": "1924625477645988",
        "facebook": {
            "first_name": "Joe",
            "last_name": "Blogs",
            "profile_pic": "https://scontent.xx.fbcdn.net/v/t31.0-1/18491707_966210440149072_5125726667986939281_o.jpg?oh=1d2e9d127908108d583816b4a2d3029f&oe=59B76722",
            "locale": "en_GB",
            "timezone": 1,
            "gender": "male",
            "is_payment_enabled": true,
            "lastRefreshedOn": "2017-05-30T14:56:46.161Z"
        }
    },
    "revision": 0,
    "etag": "\"1c-FQbvdiKOAWc7ELR9RkHnLLjOFA0\"",
    "timestamp": "2017-05-30T14:56:47.293Z"
}

Update

Example

{
    "eventId": "e625d046-80b9-430d-bfeb-fda6ba5194ed",
    "accountId": 1234,
    "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
    "name": "profile.update",
    "payload": {
        "id": "[email protected]",
        "name": "Joe Blogs",
        "email": "[email protected]"
    },
    "revision": 1,
    "etag": "\"1a-lyBG7sifukcsukcmXL87nb41J0U\"",
    "timestamp": "2017-05-31T15:26:58.199Z"
}

Delete

Example

{
    "eventId": "8e1503da-952b-4946-86c4-5c51218f39ed",
    "accountId": 1234,
    "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
    "name": "profile.delete",
    "payload": {
        "date": "2017-05-31T15:31:13.311Z",
        "by": "access:91c59b6a-5ff9-4a97-84a7-1b1ca4a0fe82",
        "id": "[email protected]"
    },
    "revision": 2,
    "etag": "\"1a-XK1WYN45Lurpx25Rz5OFoDxSl1s\"",
    "timestamp": "2017-05-31T15:31:13.479Z"
}

Undelete

Example

{
    "eventId": "99d27031-7802-4e3d-9980-322027f869f3",
    "accountId": 1234,
    "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
    "name": "profile.undelete",
    "payload": {
        "id": "[email protected]"
    },
    "revision": 3,
    "etag": "\"1a-iSV8wt9PDMKB7YICuT/LmQtrSys\"",
    "timestamp": "2017-05-31T15:34:25.066Z"
}

Devices Updated

This event provides information about the devices associated with a profile and is fired whenever there is a change in a devices capability to receive push message.

Example

{
  "eventId": "e8b015b0-dd11-4f2d-a4b8-52c20739e16b",
  "accountId": 123,
  "apiSpaceId": "c124cf6e-4352-4b26-a71a-c3032bea7a01",
  "name": "profile.devicesUpdated",
  "payload": {
    "id": "[email protected]",
    "profile": {
        "email": "[email protected]"
    },
    "devices": {
      "web": {
        "count": 2,
        "pushEnabled": 0
      },
      "mobile": {
        "count": 1,
        "pushEnabled": 1
      }
    }
  },
  "revision": 0,
  "etag": "\"15-w27xhc3Oc4ZW/h3hpKppJQ88/rU\"",
  "timestamp": "2021-07-08T14:52:29.484Z"
}