REST API
The Netmera REST API lets your backend manage users and devices, send push, email and SMS messages, read message statistics and query application data without going through the panel.
Base URL:
https://restapi.netmera.comAuthentication: every request must carry your REST API key in the
X-netmera-api-keyheader. See Setup for where to find the key and how theextId(external user ID) works.Format: request and response bodies are JSON (
Content-Type: application/json) unless an endpoint states otherwise. Error responses are listed on the Error Responses page.
Start Here
New to the API? Setup explains where to find your REST API key and how to authenticate requests.
Prefer a complete walkthrough? The Recipes take one task, such as sending a transactional push or recording consent preferences, from start to finish.
A request failed? See Error Responses.
Endpoint Index
All paths below are relative to the base URL. The Docs column links to the section that documents the endpoint.
Notifications
POST
/rest/3.0/sendBulkNotification
Send a campaign push, web push or Live Activity to a target audience
POST
/rest/3.0/sendNotification
Send a predefined (transactional) notification to specific users or devices
POST
/rest/3.0/createNotificationDefinition
Save a notification definition and get its notificationKey
POST
/rest/3.0/sendEmailWithAttachment
Send a transactional email with file attachments
POST
/rest/3.0/sendBulkEmail
Trigger an existing email template for a target audience
Events
User & Device Management
POST
/rest/3.0/deleteUsersPermanently
Permanently erase all data of the given users
POST
/rest/3.0/setCategoryPreferences
Set a user's opt-in preference for a message category
POST
/rest/3.0/pushProfileAttributes
Append values to array-type profile attributes
POST
/rest/3.0/pullProfileAttributes
Remove values from array-type profile attributes
POST
/rest/3.0/deleteProfileAttributes
Delete profile attributes from all users
Application Data
GET
/rest/3.0/app/profile-attributes
List standard and custom profile attribute definitions
Segments & Targeting
POST
/rest/3.0/targeting/count
Count the users matching a target expression
POST
/rest/3.0/targeting/count-batch
User count per value of one profile or installation attribute
Inbox
Geofence
VIA / İYS Consent
POST
/rest/via/consent
Start an İYS consent (ETK / KVK) request by short URL or OTP
POST
/rest/via/confirm
Complete an OTP consent request with the verification code
POST
/rest/via/generate-reject-mail-link
Generate email opt-out links through İYS
Last updated
Was this helpful?