"
},
"hook" : {
"name": "hook_name",
"params": {
"key1" : "val1",
"key2" : "val2"
}
}
}' \
https://restapi.netmera.com/rest/3.0/createNotificationDefinition
```
Parameters
* **title (Required):**
* Specifies the name of the campaign.
* **message (Required):**
* The default push notification message. If no personalized message is used, this message will be sent to users.
* **inbox (Optional):**
* A boolean value determining whether to display the push notification in the inbox.
* **platforms (Required):**
* Indicates the platforms capable of receiving this notification.
* **personalizedMessage (Optional):**
* If a user-specific message is to be sent, utilize the @{xxxx} placeholder. Placeholders can be profile attributes or sent via a transactional message call.
* **click (Optional):**
* Specifies the default push click action. This action can be overridden by a transactional message call.
* **ios (Optional):**
* Contains optional parameters specific to iOS.
* **android (Optional):**
* Holds optional parameters specific to Android.
* **hook (Optional):**
* Includes optional hook parameters. If no hook is to be attached, exclude the hook block from the request.
Parameters
**Given:** A push notification is created for users utilizing the "Create New Notification" service.
**When:** Label information is added to the message.
**Then:** The push notification is sent.
**And:** Confirmation is observed as the label field appears in the push report generated on the panel.
#### Sample Response:
```json
{
"notificationKey": 96
}
```
Parameters
The notificationKey serves as the identifier for your message definition. This unique key is used when making a transactional message call, connecting the message to its predefined definition. Ensure to utilize this specific notificationKey to maintain coherence between your message definitions and transactional messages.
### Button Sets
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"title": "Important Survey",
"message": "We would love to hear your feedback!",
"inbox": false,
"platforms": ["IOS", "ANDROID"],
"click": {
"deeplink": "https://www.netmera.com"
},
"buttonSet": {
"id" : 1,
"Yes" : "https://netmera.com/yes-feedback",
"No" : "https://netmera.com/no-feedback"
}
}' \
https://restapi.netmera.com/rest/3.0/createNotificationDefinition
```
### Carousel Push
```json
curl --location 'https://restapi.netmera.com/rest/3.0/createNotificationDefinition' \
--header 'X-netmera-api-key: your_rest_api_key' \
--header 'Content-Type: application/json' \
--data '{
"platforms": [
"ANDROID",
"IOS"
],
"text": "Explore our Products",
"message": "Check out our amazing image slider!",
"title": "Product Showcase",
"click": {
"url": "https://www.example.com/products"
},
"ios": {
"title": "Discover on iOS",
"carousel": [
{
"title": "Featured Product",
"content": "Explore our flagship item.",
"itemImageUrl": "https://example.com/images/product1.jpg",
"clickAction": {
"action": "DEEP_LINK",
"url": "https://www.example.com/products/featured",
"deeplinkType": "URL",
"deepLinkUrl": "https://example.com/deeplink/featured"
}
},
{
"title": "New Arrival",
"content": "Check out the latest addition to our collection.",
"itemImageUrl": "https://example.com/images/newarrival.jpg"
}
]
},
"android": {
"title": "Discover on Android",
"carousel": [
{
"title": "Special Offer",
"content": "Do not miss out on our exclusive discount.",
"itemImageUrl": "https://example.com/images/specialoffer.jpg"
},
{
"title": "Top Picks",
"content": "Explore our curated selection of top products.",
"itemImageUrl": "https://example.com/images/toppicks.jpg",
"clickAction": {
"action": "DEEP_LINK",
"url": "https://www.example.com/products/toppicks",
"deeplinkType": "URL",
"deepLinkUrl": "https://example.com/deeplink/toppicks"
}
}
]
}
}'
```
### Slider Push
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"message": {
"platforms": [
"ANDROID",
"IOS"
],
"text": "Exciting announcement! New features are now available.",
"message": "Check out the latest updates.",
"title": "New Features Alert",
"click": {
"deeplink": "https://www.netmera.com"
},
"ios": {
"title": "Discover on iOS",
"slider": [
{
"itemImageUrl": "https://example.com/ios-image1.png",
"clickAction": {
"url": "https://www.netmera.com"
}
},
{
"itemImageUrl": "https://example.com/ios-image2.png"
}
]
},
"android": {
"title": "Explore on Android",
"slider": [
{
"itemImageUrl": "https://example.com/android-image1.png",
"clickAction": {
"url": "https://www.netmera.com"
}
},
{
"itemImageUrl": "https://example.com/android-image2.png"
}
]
}
}
}' \
https://restapi.netmera.com/rest/3.0/createNotificationDefinition
```
## Transactional Notifications with Features
### Transactional with Deeplink
Add a deeplink to your transactional notification, allowing you to redirect users to a specific view or content upon clicking the notification.
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"notificationKey": "3",
"target": {
"extId": "user123"
},
"message": {
"params": {
},
"click" : {
"deeplink" : "https://www.google.com"
}
}
}' \
https://restapi.netmera.com/rest/3.0/sendNotification
```
### Transactional with URL
Add a URL to your transactional notification, enabling the opening of a landing page in a default web view after users click on the notification. This allows you to direct users to specific web content or external pages related to the transactional notification.
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"notificationKey": "3",
"target": {
"extId": "user123"
},
"message": {
"params": {
},
"click" : {
"url" : "https://www.netmera.com"
}
}
}' \
https://restapi.netmera.com/rest/3.0/sendNotification
```
### Transactional with Rich Media
To send a transactional notification with rich media content, utilize the following request, allowing the inclusion of title, subtitle, and different types of media based on the platform:
* **Title and Subtitle:**
* Include title and subtitle in your transactional notification.
* **Rich Media:**
* For Android, include an image. For iOS, include an image, sound, or video.
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"notificationKey": "3",
"target": {
"extId": "user123"
},
"message": {
"params": {
},
"ios": {
"mediaUrl": "https://example.com/media-ios.mp4",
"title": "iOS Title",
"subtitle": "iOS Subtitle",
"thumbnailUrl" : "https://example.com/thumbnail-ios.png"
},
"android": {
"mediaUrl": "https://example.com/media-android.mp4",
"title": "Android Title",
"subtitle": "Android Subtitle",
"bigText" : "Android Big Text",
"thumbnailUrl" : "https://example.com/thumbnail-android.png"
}
}
}' \
https://restapi.netmera.com/rest/3.0/sendNotification
```
### Transactional with Sound & Vibration
When sending a transactional notification with sound and vibration, follow these steps:
* **Sound Definition:**
* Define sounds in the panel under Developers/Sounds menu.
* **Platform-specific Sound Setting:**
* Set sounds for each platform accordingly. This ensures that the appropriate sound is played based on the user's device platform.
{% hint style="info" %}
**Note:** Ensure that the sounds are defined in the panel under Developers/Sounds before attempting to use them in your transactional notification. This allows for a customized and platform-specific audio experience for users.
{% endhint %}
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"notificationKey": "3",
"target": {
"extId": "user123"
},
"message": {
"params": {
},
"ios": {
"sound" : "custom_ios_sound"
},
"android": {
"vibration" : true,
"sound" : "custom_android_sound"
}
}
}' \
https://restapi.netmera.com/rest/3.0/sendNotification
```
### Transactional with Custom Parameters
To customize your transactional notification further, consider adding custom parameters with the following request. These parameters can then be utilized on the device when the push notification is received.
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"notificationKey": "4",
"target": {
"extId": "user456"
},
"message": {
"params": {
},
"customJson" : {
"key" : "custom_value"
}
}
}' \
https://restapi.netmera.com/rest/3.0/sendNotification
```
### Other parameters
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"notificationKey": "4",
"target": {
"extId": "user456"
},
"message": {
"params": {
},
"ttl": "15d",
"inbox": true,
"doNotNotify": false
}
}' \
https://restapi.netmera.com/rest/3.0/sendNotification
```
Parameters
* **ttl (Optional):**
* Time to live value of the notification. If any target device does not receive the notification within the given period, it will not be received. Example usage: 15d means 15 days, 20h means 20 hours, and 30m means 30 minutes.
* **inbox (Optional):**
* A boolean value that determines whether to display the push notification in the inbox or not.
* **doNotNotify (Optional):**
* A boolean value that determines whether to show the push notification on the notification center or not.
### Transactional to Last Device
You may utilize the `last device` field optionally when sending push notifications to target the last devices of the users.
* **"lastActiveDevice": true** → Sending to Last Active Device
* **"lastActiveDevice": false** → Sending to All Devices
```json
curl --location 'https://restapi.netmera.com/rest/3.0/sendNotification' \
--header 'X-netmera-api-key: your_rest_api_key' \
--header 'Content-Type: application/json' \
--data '{
"notificationKey": "2071",
"lastActiveDevice": true,
"message": {
"params": {
"name": "John"
}
},
"target": {
"extId": "123123123"
}
}'
```
### Transactional with Profile Attributes
```json
curl --location 'https://restapi.netmera.com/rest/3.0/sendNotification' \
--header 'X-netmera-api-key: your_rest_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
"notificationKey": "1000",
"target": {
"pa": {
"pb": "Smith"
}
}
}'
```
In the command, **`pa`** is a placeholder for the type of profile attribute you're targeting, and **`pb`** is the **specific code** for the surname attribute. Essentially, you're sending the notification with id number 1000 to users whose surname matches with "Smith." Instead of code "pb", you may use other profile attribute codes as specified in the **Developers > Profile Attributes > Code** section.
### Adding Multiple Profile Attributes
```json
curl --location 'https://restapi.netmera.com/rest/3.0/sendNotification' \
--header 'X-netmera-api-key: your_rest_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
"notificationKey": "1000",
"target": {
"pa": {
"pb": ["Smith", "Johnson"]
}
}
}'
```
In this command:
* `"pb": ["Smith", "Johnson"]`: Indicates that the notification will be sent to users whose surname matches "Smith" **or** "`Johnson`". You can add more values within the array to target additional profile attribute values.
{% hint style="info" %}
**Logical Operators**:
Conditions within the same attribute (e.g., `"pb": ["Smith", "Johnson"]`) are connected by `OR`. This means the notification will be sent to users whose surname matches either "Smith" or "Johnson".
{% endhint %}
### Updating Button Set Names with Transactional Push
{% hint style="info" %}
**Integration Updates:**
In the `sendNotification` and `createNotificationDefinition` APIs, the field called `buttonNames` can be used to facilitate the renaming of buttons. When providing new button names corresponding to the old ones, users will receive notifications with these new names. If the `buttonNames`field is not included in the request, notifications will be sent with the old button names.
{% endhint %}
{% hint style="warning" %}
**Needs Service Extension Integration for iOS:**
If you wish to use this feature with iOS devices you need to complete Service Extention Integration for iOS. You may see [media-push](https://user.netmera.com/netmera-developer-guide/platforms/ios/new-ios-swift/push-notifications/media-push "mention") on how to complete this integration for Swift SDK and [media-push](https://user.netmera.com/netmera-developer-guide/platforms/ios/former-ios-objective-c/push-notifications/media-push "mention") for former iOS SDK.
{% endhint %}
**Sample request for `createNotificationDefinition`**
```json
curl --location --request POST 'https://restapi.netmera.com/rest/3.0/createNotificationDefinition' \
--header 'X-netmera-api-key: your-rest-api-key' \
--header 'Content-Type: application/json' \
--data-raw '{
"title": "Important Survey",
"message": "We would like to get a feedback",
"inbox": false,
"platforms": [
"ANDROID"
],
"click": {
"deeplink": "https://www.netmera.com"
},
"buttonSet": {
"id": 1, //your button id (visible on Settings > Button Sets)
"buttonNames": {
"button1": "15 GB-10 USD", //"old button name" : "new button name"
"button2": "15 GB-15 USD"
},
"15 GB-10 USD": "https://www.google.com", //"new button name" : "url"
"15 GB-15 USD": "https://www.youtube.com"
}
}
}'
```
**Sample request for `sendNotification`**
curl--location --request POST 'https://restapi.netmera.com/rest/3.0/sendNotification' \
--header 'X-netmera-api-key: your-rest-api-key' \
--header 'Content-Type: application/json' \
--data-raw '{
"notificationKey": "1000",
"target": {
"extId": ["exid", "exid22"]
},
"message": {
"buttonSet": {
"id": 1,
"buttonNames": {
"button1": "15 GB-10 USD",
"button2": "15 GB-15 USD"
},
"15 GB-10 USD": "https://www.google.com",
"15 GB-15 USD": "https://www.youtube.com"
}
}
}'
### Create Web Transactional Push
To create a Web Transactional Push notification using the curl command, you can structure your command as follows:
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"title": "New Announcement",
"personalizedTitle": "@{titleHere}",
"message": "Discover our latest updates!",
"personalizedMessage": "Explore now: @{message}",
"platforms": ["CHROME","SAFARI","EDGE","YANDEX","FIREFOX","OPERA"],
"click": {
"deeplink": "https://www.netmera.com"
}
}' \
https://restapi.netmera.com/rest/3.0/createNotificationDefinition
```
### Web Transactional Push
To send a Web Transactional Push notification using the curl command, you can structure your command as follows:
```json
curl --location 'https://restapi.netmera.com/rest/3.0/sendNotification' \
--header 'X-netmera-api-key: your_rest_api_key' \
--header 'Content-Type: application/json' \
--data '{
"notificationKey": "2071",
"target": {
"extId": "YOUR USER IDENTIFIER"
},
"message": {
"params": {
}
}
}'
```
### Web Transactional Push with Deeplink
To send a Web Transactional Push notification with Deeplink using the curl command, you can structure your command as follows:
```json
curl --location 'https://restapi.netmera.com/rest/3.0/sendNotification' \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"notificationKey": "1408",
"target": {
"extId": "exidname"
},
"message": {
"params": {},
"click": {
"deeplink": "https://www.netmera.com?id=5&name=@{exid}&cat=webpush"
}
}
}'
```
{% hint style="danger" %}
**@{parameters} must be valid for users:**
When using parameters like @{extID} in deeplinks, it's important to ensure that these parameters correspond to actual user data. If these parameters don't exist for users, even if the users match the specified targets, the notification delivery won't be successful. In simpler terms, make sure the parameters you use in deeplinks are valid and available in the user data to avoid issues with sending notifications. You may see the documentation on [#create-new-deeplink](https://user.netmera.com/netmera-developer-guide/platforms/web/deep-linking#create-new-deeplink "mention").
{% endhint %}
## Push Stats
### By Notification Key
With the following request, you can reach the stats of a notification.
```json
curl -X GET \
-H "X-netmera-api-key: your_rest_api_key" \
-G \
--data-urlencode notificationKey=234 \
'https://restapi.netmera.com/rest/3.0/getPushStats'
```
Parameters
* **notificationKey (Required):**
* This is the notification key associated with a particular message for which you want to retrieve statistics. It is a required parameter and plays a crucial role in identifying the specific message for which you seek statistical information.
#### Sample response:
```json
{
"notificationKey": 234,
"status": "FINISHED",
"startDate": 1504790916883,
"endDate": 1504790916917,
"stats": [
{
"platform": "IOS",
"sent": 100,
"failed": 5,
"clicked": 35
},
{
"platform": "ANDROID",
"sent": 300,
"failed": 25,
"clicked": 98
},
{
"platform": "WP",
"sent": 30,
"failed": 1,
"clicked": 23
}
]
}
```
### By Date Range
With the following request, you can reach the stats of a notification.
```json
curl -X GET \
-H "X-netmera-api-key: your_rest_api_key" \
-G \
--data-urlencode start=1501132423424 \
--data-urlencode end=150122342432 \
'https://restapi.netmera.com/rest/3.0/getPushStats'
```
Parameters
* **start (Required):**
* The start date, specified in milliseconds, is a required parameter. It determines the beginning of the time range for which you want to retrieve data.
* **end (Required):**
* The end date, also specified in milliseconds, is a required parameter. It marks the conclusion of the time range for which you want to obtain data.
#### Sample response:
```json
{
"messages": [
{
"status": "FINISHED",
"stats": [
{
"platform": "IOS",
"sent": 6,
"failed": 0,
"clicked": 0
},
{
"platform": "ANDROID",
"sent": 0,
"failed": 0,
"clicked": 0
}
],
"startDate": 1504790916883,
"endDate": 1504790916917,
"notificationKey": 749
},
{
"status": "SENDING",
"stats": [
{
"platform": "IOS",
"sent": 1,
"failed": 0,
"clicked": 1
},
{
"platform": "ANDROID",
"sent": 0,
"failed": 0,
"clicked": 0
}
],
"startDate": 1504790402907,
"endDate": 1504790402909,
"notificationKey": 748
}
]
}
```
## Get Push Result
To retrieve users' push results (success or failure), use the following request. If start and end dates are not specified, the results for the last 2 weeks will be returned.
```json
curl -X GET \
-H "X-netmera-api-key: your_rest_api_key" \
-G \
--data-urlencode max=10 \
--data-urlencode notificationKey=106 \
--data-urlencode extId=B4A92950-B0FD-43E6-B312-C3EE088890BD \
--data-urlencode start=1557892331000 \
--data-urlencode end=1557892431000 \
--data-urlencode token=cKuWDH0ZOw4:APA91bEduwC4_FWB5i-isvsSbNO5Dglxg7Wstd8dOI8k8MgP-M2IryebG0PRctVzJ5vkkhDLh3QDEorv6-CfYvvO-rmCMjoUOI_unL3kvQOfi9op_JBzBzwNXGGzwfMLpVSAdYi6xNwn \
'https://restapi.netmera.com/rest/3.0/getPushResult'
```
Parameters
* **start (Optional):**
* Start date in milliseconds. If provided, it sets the beginning of the time range for retrieving results.
* **end (Optional):**
* End date in milliseconds. If provided, it marks the conclusion of the time range for retrieving results.
* **notificationKey (Optional):**
* Notification ID on the panel. If specified, it filters results based on the given notification.
* **extId (Optional):**
* External ID for obtaining message results of a specific user. If provided, it narrows down the results to the specified user.
* **token (Optional):**
* Device token for acquiring message results of a specific device. If included, it restricts the results to the specified device.
#### Sample response:
```json
{
"nextPage": "https://restapi.netmera.com/rest/3.0/getPushResult?offset=hJbolUuHucJ9dd&max=10",
"list": [
{
"platform": "IOS",
"status": "FAILED",
"errorCode": "8",
"installationId": "C2Ii2ztdEaok0",
"errorMsg": "INVALID_TOKEN",
"timeStamp": 1557819194426,
"msgTitle": "Awesome Title",
"msgText": "How is it going, Jon?"
},
{
"platform": "ANDROID",
"status": "SUCCESS",
"installationId": "U7IwgcM8phSmv",
"extId": "B4A92950-B0FD-43E6-B312-C3EE088890BD",
"timeStamp": 1557819194426,
"msgTitle": "Awesome Title",
"msgText": "How is it going, Jon?"
}
// ... Additional entries
]
}
```
Parameters
* **notificationKey (Required):**
* Notification key of a message to obtain users' responses. This is a required parameter that identifies the specific message for which you want to retrieve user responses.
* **max (Optional):**
* The default value is 10. This parameter determines the maximum number of result info to fetch per page. It is optional, and if not specified, the default value of 10 will be used.
* **Next Page Retrieval:**
* To fetch the next page of results, you need to send a request to the nextPage value. This mechanism enables the retrieval of additional information beyond the initial page.
```json
curl -X GET \
-H "X-netmera-api-key: your_rest_api_key" \
'https://restapi.netmera.com/rest/3.0/getPushResult?offset=hJbolUuHucJ9dd&max=10'
```
{% hint style="info" %}
**SMS and Email Notification Key Details:**
When you provide the notification key for SMS and email notifications made before, it returns the success and failure details for each individual email or SMS sent.
{% endhint %}
**Example for Email:**
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"target": {
"email": "target_email@example.com"
},
"platforms": [
"EMAIL"
],
"title": "Your Account is Created",
"message": "HELLO
SPACE
",
"from": "info@netmera.com",
"senderName": "Netmera",
"subject": "Your Account is Created"
}' \
https://restapi.netmera.com/rest/3.0/sendEmailAndSms
```
#### Example for SMS:
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"target": {
"msisdn": "target_msisdn"
},
"platforms": [
"SMS"
],
"title": "Account Notification",
"message": "Your recent account activity: message",
"smsHeader": "NETMERA"
}' \
https://restapi.netmera.com/rest/3.0/sendEmailAndSms
```
### Send Notification to Custom Target
To send a notification to a specific group of people, whether categorized by tags, segments, location, or profile attributes, follow these guidelines:
* **Target Specification:**
* You must define a specific target (tag, segment, location, or profile attribute) for the notification.
* **Note:**
* Leaving the target empty is not allowed. If you intend to send a notification to all users, set the `sendToAll` attribute to true. This attribute ensures the notification is broadcasted to all users.
## Geofence
Geofences can be established via the Rest API.
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"title": "Sample Geofence",
"latitude": 38.43225,
"longitude": 40.212421,
"radius": 5,
"unit": "KM",
"groups": [
"Sample Group"
]
}' \
https://restapi.netmera.com/rest/3.0/geofence/add
```
Parameters
* **title (Required):**
* Geofence name at Dashboard.
* **latitude (Required):**
* Latitude of the center point.
* **longitude (Required):**
* Longitude of the center point.
* **radius (Required):**
* Radius value in kilometers from the center to search for users. The unit can be KM, Miles, or Meters. The default value is KM.
## Email
Use the notification key created from the panel to work with email functionality.
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"notificationKey": "12",
"target": {
"email": "YOUR USER IDENTIFIER"
},
"message": {
"params": {}
}
}' \
https://restapi.netmera.com/rest/3.0/sendNotification
```
### Send Email with Attachment
You may add more than one attachment. However, the email size and the total size of attachments **should not exceed 10 MB.**
{% hint style="info" %}
**Supported file types:**
"image/png", "video/x-msvideo", "video/mp4", "video/mpeg", "video/mpeg2", "video/x-mpeg", "image/gif", "image/jpeg", "image/x-png", "image/x-citrix-png", "image/x-citrix-jpeg", "text/plain", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.ms-excel", "text/csv", "xlsx", "xls", "csv", "txt", "pdf", "jpg", "jpeg", "png", "gif", "mpeg", "mpeg-2", "mp4", "avi".
{% endhint %}
```bash
curl --location 'https://netmera.com/rest/3.0/sendEmailWithAttachment' \
--header 'X-netmera-api-key: your_api_key' \
--form 'mailAttachment=@"/path/to/file"' \
--form 'to="example@netmera.com"' \
--form 'notificationKey="1000"'
```
Please ensure that you adhere to the specified requirements and supported file types when using the `sendEmailWithAttachment` method.
### Add or Update Emails
You can utilize the `addEmail` method to upload or update a list of emails to Netmera.
```bash
curl --location --request POST 'https://restapi.netmera.com/rest/3.0/addEmail' \
--header 'X-netmera-api-key: your_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
"emailList": [
"example1@netmera.com", "example2@gmail.com", "example3@gmail.com"
]
}'
```
{% hint style="info" %}
#### addEmail Method Reminders:
* If the email already exists with the `addEmail` service (e.g., in a user with an ExtID or a user previously added with this service), a new user will not be created.
* If a user is added using the `addEmail` service, a new user will only be created in the dashboard if no user with this email already exists. These users will not have an installation ID, so the installation ID will not be visible when searching by email or user ID in the People section.
* Users created with the `addEmail` service can be viewed in the dashboard. However, if a new user is created from the SDK using the same email, the initially created user with `addEmail` will be deleted. The information from the SDK is considered master, and targeting is done on the SDK user.
* You can use this service only to upload email lists. Upload can be done within the KB limit without a maximum limit.
{% endhint %}
### Creating a Template for Sending Email
Follow the example provided below to create a template for sending an email to a user.
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"target": {
"email": "target_email"
},
"platforms": [
"EMAIL"
],
"title": "AccountCreationNotification",
"message": "Hello,
This is a test email.
",
"from": "info@netmera.com",
"senderName": "Netmera",
"subject": "Account Creation Notification"
}' \
https://restapi.netmera.com/rest/3.0/sendEmailAndSms
```
## SMS
You can work with sms with the notification key you create from the panel.
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"notificationKey": "3964",
"target": {
"extId": "YOUR USER IDENTIFIER"
},
"message": {
"params": {}
}
}' \
https://restapi.netmera.com/rest/3.0/sendNotification
```
### Add or Update MSISDN (Phone Number)
The `addMsisdn` method is used to add users with the specified MSISDNs (phone numbers) to the Netmera platform.
{% hint style="warning" %}
**Mandatory to include the country codes:**
When using this service, it is mandatory to include the country code in the phone numbers, i.e., the phone numbers should be in the format of "+90xxxxxxxx".
{% endhint %}
```bash
curl --location --request POST 'https://restapi.netmera.com/rest/3.0/addMsisdn' \
--header 'X-netmera-api-key: your_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
"msisdnList": [
"+90xxxxxxxx"
]
}'
```
{% hint style="info" %}
**AddMsisdn Method Reminders:**
* If the MSISDN already exists with the service (e.g., in a user with an ExtID or a user previously added with this service), a new user will not be created.
* If a user is added using these services, a new user will only be created in the dashboard if no user with this information already exists. These users will not have an installation ID, so the installation ID will not be visible when searching by user ID in the People section.
* Users created with these services can be viewed in the dashboard. However, if a new user is created from the SDK using the same MSISDN, the initially created user will be deleted. The information from the SDK is considered primary, and targeting is done on the SDK user.
* You can use this service only to upload msisdn lists. Upload can be done within the KB limit without a maximum limit.
{% endhint %}
### Creating a Template for Sending SMS to a User
Follow the example provided below to create a template for sending an SMS to a user.
```json
curl -X POST \
-H "X-netmera-api-key: your_rest_api_key" \
-H "Content-Type: application/json" \
-d '{
"target": {
"msisdn": "target_msisdn"
},
"platforms": [
"SMS"
],
"title": "SMS Title",
"message": "Hello, this is your SMS message.",
"smsHeader": "NETMERA",
"smsIysMessageType": // "N" For Notification "C" for Campaign,
"smsIysRecipientType": // "B" For Personal "T" For Trader
}' \
https://restapi.netmera.com/rest/3.0/sendEmailAndSms
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://user.netmera.com/netmera-developer-guide/api-documentation/rest-api/notifications.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
