Messages

Notification cancel

POST https://exchange-prod-g.2mee.com/notification/cancel

Cancels a scheduled notification. It can only be cancelled at least 5 minutes before the playtime.

Path Parameters

NameTypeDescription

id

string

Notification Id to be cancelled. 

{
    "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
    "title": "Title of the Message",
    "subtitle": "SubTitle of the Message",
    "text": "Body of the Message",
    "action": "Open",
    "fbTitle": "updated FallBack Title of the Message",
    "fbSubtitle": "Fallback SubTitle of the Message",
    "fbText": "FallBack Text of the Message",
    "expiry": 1440,
    "playTime": 1582614107000,
    "about": [{
        "key": "__openExternalURL",
        "value": "https://2mee.com/"
    }],
    "filterId": "9e862fc2-e3b6-4420-bf63-80ad4368ec88",
    "priority": "LOW",
    "favourite": 0,
    "type": "TEXT",
    "channel": "PUSH",
    "segment": {
        "name": "All Users",
        "type": "DEFAULT",
        "count": null
    },
    "subType": "I",
    "createdBy": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
    "state": "CANCELLED",
    "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
    "messageTitle": null,
    "url": "https://secureexchange.s3.eu-geo.objectstorage.softlayer.net/f4769c89-939b-4521-9435-5b3ce49d8fdb_d31da127-d00e-413c-9c3f-7a03af52b778.jpg",
    "id": "f4769c89-939b-4521-9435-5b3ce49d8fdb",
    "size": 13097,
    "tags": [],
    "parentMessageId": null,
    "holoPushAd": null,
    "jobId": null,
    "holoPushUrl": null
}
$ curl 'https://exchange-prod-g.2mee.com/notification/cancel?id=f4769c89-939b-4521-9435-5b3ce49d8fdb' 
-i -X POST  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlLmNvbSIsImV4cCI6MTU4OTQ1NTc0OSwiaWF0IjoxNTg5NDM3NzQ5fQ.U2VtugGzqD0s9p0rUXaTxk8F5tHeMf5SB4ZRnYM8TV4QQm6y2FvdFIfD6kjQOhcYuPglSusAjVegzHqDKGgCqA'

Message delete

DELETE https://exchange-prod-g.2mee.com/notification/delete

Delete the message before scheduling. Notification with SCHEDULED state cannot be deleted.

Path Parameters

NameTypeDescription

id

string

Message Id to be deleted.

{
  "code" : 200,
  "message" : "Success."
}
$ curl 'https://exchange-prod-g.2mee.com/notification/delete?id=f4769c89-939b-4521-9435-5b3ce49d8fdb' 
-i -X DELETE -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlLmNvbSIsImV4cCI6MTU3OTYyMjQ1NiwiaWF0IjoxNTc5NjA0NDU2fQ.vogap4Na2O8-z4lLowb8zMdyAWsp2iajr_XwIsYAHEDodzejcYgp2m2yF874xjk67OhkScWGXeIp7gongfhKtQ'

Message search

GET https://exchange-prod-g.2mee.com/notification/find

Returns message information. The user retrieving the information and the message must belong to the same company.

Path Parameters

NameTypeDescription

id

string

Message Id whose information is to be retrieved.

{
    "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
    "title": "Title of the Message",
    "subtitle": "SubTitle of the Message",
    "text": "Body of the Message",
    "action": "Open",
    "fbTitle": "updated FallBack Title of the Message",
    "fbSubtitle": "Fallback SubTitle of the Message",
    "fbText": "FallBack Text of the Message",
    "expiry": 1440,
    "playTime": 1582614107000,
    "about": [{
        "key": "__openExternalURL",
        "value": "https://2mee.com/"
    }],
    "filterId": "9e862fc2-e3b6-4420-bf63-80ad4368ec88",
    "priority": "LOW",
    "favourite": 0,
    "type": "TEXT",
    "channel": "PUSH",
    "segment": null,
    "subType": "I",
    "createdBy": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
    "state": "DELIVERED",
    "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
    "messageTitle": null,
    "url": "https://secureexchange.s3.eu-geo.objectstorage.softlayer.net/f4769c89-939b-4521-9435-5b3ce49d8fdb_d31da127-d00e-413c-9c3f-7a03af52b778.jpg",
    "id": "f4769c89-939b-4521-9435-5b3ce49d8fdb",
    "size": 13097,
    "tags": [],
    "parentMessageId": null,
    "holoPushAd": null,
    "jobId": null,
    "holoPushUrl": null
}
$ curl 'https://exchange-prod-g.2mee.com/notification/find?id=f4769c89-939b-4521-9435-5b3ce49d8fdb' 
-i -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlL

Message duplicate

POST https://exchange-prod-g.2mee.com/notification/duplicate

Duplicate the delivered notification. If a new audience is provided it replaces the original notification's audience otherwise retains the original audience.

Path Parameters

NameTypeDescription

id

string

Message Id to be duplicated.

filterId

string

Audience picked up for the delivery of the notification. It can be found from audience listing API.

{
    "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
    "title": "Title of the Message",
    "subtitle": "SubTitle of the Message",
    "text": "Body of the Message",
    "action": "Open",
    "fbTitle": "updated FallBack Title of the Message",
    "fbSubtitle": "SubTitle of the Message",
    "fbText": "Body of the Message",
    "expiry": 1440,
    "playTime": "2020-05-22",
    "about": [{
        "key": "__openExternalURL",
        "value": "https://2mee.com/"
    }],
    "filterId": "9e862fc2-e3b6-4420-bf63-80ad4368ec88",
    "priority": "LOW",
    "favourite": 0,
    "type": "TEXT",
    "channel": "PUSH",
    "segment": null,
    "subType": "I",
    "createdBy": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
    "state": "NEW",
    "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
    "messageTitle": null,
    "url": "https://secureexchange.s3.eu-geo.objectstorage.softlayer.net/0542ab77-2d2e-48c1-8a0d-9714062eb8ee_c93ac3f8-4a02-4344-ba13-9170f01074f9.jpg",
    "id": "0542ab77-2d2e-48c1-8a0d-9714062eb8ee",
    "size": 13097,
    "tags": null,
    "parentMessageId": null,
    "holoPushAd": null,
    "jobId": null,
    "holoPushUrl": null
}
$ curl 'https://exchange-prod-g.2mee.com/notification/duplicate?id=0730fc52-9125-41eb-bf99-9124e4acc425&filterId=9e862fc2-e3b6-4420-bf63-80ad4368ec88' 
-i -X POST -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlLmNvbSIsImV4cCI6MTU4OTQ1NTc0OSwiaWF0IjoxNTg5NDM3NzQ5fQ.U2VtugGzqD0s9p0rUXaTxk8F5tHeMf5SB4ZRnYM8TV4QQm6y2FvdFIfD6kjQOhcYuPglSusAjVegzHqDKGgCqA'

Message retarget

POST https://exchange-prod-g.2mee.com/notification/retarget

Duplicates the notification by selecting an audience based on engagement. If the engaged field is empty original audience is retained.

Path Parameters

NameTypeDescription

notificationId

string

Notification Id to be retargeted.

appId

string

Application Id for which the retarget notification has to be created.

engaged

string

Engaged ID in string format 1.ENGAGED 2.NOT_ENGAGED 3.ALLUSERS

{
    "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
    "title": "Title of the Message",
    "subtitle": "SubTitle of the Message",
    "text": "Body of the Message",
    "action": "Open",
    "fbTitle": "updated FallBack Title of the Message",
    "fbSubtitle": "SubTitle of the Message",
    "fbText": "Body of the Message",
    "expiry": 1440,
    "playTime": "2020-05-22",
    "about": [{
        "key": "__openExternalURL",
        "value": "https://2mee.com/"
    }],
    "filterId": "9e862fc2-e3b6-4420-bf63-80ad4368ec88",
    "priority": "LOW",
    "favourite": 0,
    "type": "TEXT",
    "channel": "PUSH",
    "segment": null,
    "subType": "I",
    "createdBy": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
    "state": "NEW",
    "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
    "messageTitle": null,
    "url": "https://secureexchange.s3.eu-geo.objectstorage.softlayer.net/1f9c7cac-1755-43c4-bf6c-92d5d65e7441_a3d9bc4b-8051-4a9d-abf9-0f2bae7e8e7e.jpg",
    "id": "1f9c7cac-1755-43c4-bf6c-92d5d65e7441",
    "size": 13097,
    "tags": null,
    "parentMessageId": "f4769c89-939b-4521-9435-5b3ce49d8fdb",
    "holoPushAd": null,
    "jobId": null,
    "holoPushUrl": null
}
$ curl 'https://exchange-prod-g.2mee.com/notification/retarget?notificationId=f4769c89-939b-4521-9435-5b3ce49d8fdb&appId=bacb37d0-a51f-491b-bd68-489c245b8c16&engaged=ALLUSERS' 
-i -X POST  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlLmNvbSIsImV4cCI6MTU4OTQ1NTc0OSwiaWF0IjoxNTg5NDM3NzQ5fQ.U2VtugGzqD0s9p0rUXaTxk8F5tHeMf5SB4ZRnYM8TV4QQm6y2FvdFIfD6kjQOhcYuPglSusAjVegzHqDKGgCqA'
PreviousAdvancedNextHoloPush

Last updated