For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.com

  • Authentication: every request must carry your REST API key in the X-netmera-api-key header. See Setup for where to find the key and how the extId (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.

Most write endpoints accept at most 1000 unique external IDs per request. Split larger batches into multiple requests.

Endpoint Index

All paths below are relative to the base URL. The Docs column links to the section that documents the endpoint.

Notifications

Method
Endpoint
Description
Docs

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/sendEmailAndSms

Define an email or SMS message inline and send it to targets

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

GET

/rest/3.0/getPushStats

Sent, failed and clicked counts for a message or a date range

GET

/rest/3.0/getPushResult

Per-recipient delivery results, paginated

GET

/rest/3.0/getPushCategories

List the message categories of the application

POST

/rest/3.0/update-live-activity

Update or end an iOS Live Activity

Events

Method
Endpoint
Description
Docs

POST

/rest/3.0/fireEvents

Send custom or standard events for users

User & Device Management

Method
Endpoint
Description
Docs

POST

/rest/3.0/registerUsers

Register or update users and their devices

POST

/rest/3.0/deleteUsers

Delete users from the application

POST

/rest/3.0/deleteUsersPermanently

Permanently erase all data of the given users

POST

/rest/3.0/enablePush

Opt a user or device in to push notifications

POST

/rest/3.0/disablePush

Opt a user or device out of push notifications

POST

/rest/3.0/tagUsers

Add a tag to users

POST

/rest/3.0/untagUsers

Remove a tag from users

POST

/rest/3.0/setCategoryPreferences

Set a user's opt-in preference for a message category

GET

/rest/3.0/getCategoryPreferences

Read a user's message category preferences

GET

/rest/3.0/getProfileAttributes

Read a user's profile attributes

POST

/rest/3.0/setProfileAttributes

Set or update profile attributes of users

POST

/rest/3.0/unsetProfileAttributes

Remove profile attributes from users

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

GET

/rest/3.0/getDevices

List the devices of a user

GET

/rest/3.0/getDeviceTokens

List all device tokens, paginated

POST

/rest/3.0/addTesters

Register users' devices as test devices

GET

/rest/3.0/count-user

Count users with push permission

POST

/rest/3.0/promotion/add

Assign promotion codes to users

POST

/rest/3.0/addEmail

Create users from a list of email addresses

POST

/rest/3.0/enableMail

Opt users in to email

POST

/rest/3.0/disableMail

Opt users out of email

POST

/rest/3.0/updateEmail

Change a user's email address

POST

/rest/3.0/removeEmail

Clear a user's email address

POST

/rest/3.0/addMsisdn

Create users from a list of phone numbers

POST

/rest/3.0/enableSms

Opt users in to SMS

POST

/rest/3.0/disableSms

Opt users out of SMS

POST

/rest/3.0/updateMsisdn

Change a user's phone number

POST

/rest/3.0/removeMsisdn

Clear a user's phone number

POST

/rest/3.0/enableWhatsApp

Grant WhatsApp permission to users

POST

/rest/3.0/disableWhatsApp

Revoke WhatsApp permission from users

POST

/rest/3.0/updateWhatsApp

Change a user's WhatsApp number

POST

/rest/3.0/removeWhatsApp

Clear a user's WhatsApp number

Application Data

Method
Endpoint
Description
Docs

GET

/rest/3.0/app/profile-attributes

List standard and custom profile attribute definitions

GET

/rest/3.0/app/events

List standard and custom event definitions

Segments & Targeting

Method
Endpoint
Description
Docs

GET

/rest/3.0/getSegments

List the segments defined in the panel

GET

/rest/3.0/getSegmentUsers

List the users of a segment, paginated

POST

/rest/3.0/createSegment

Create a segment from one or more conditions

GET

/rest/3.0/getSegment

Read the calculation status and user count of a segment

POST

/rest/3.0/updateSegment

Change the conditions of a segment and calculate it again

POST

/rest/3.0/changeSegmentStatus

Delete a segment or reopen a deleted one

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

Method
Endpoint
Description
Docs

POST

/rest/3.0/inbox/getAllInbox

List a user's inbox messages with unread counts

GET

/rest/3.0/inbox/get

Fetch a single inbox message

POST

/rest/3.0/inbox/statusChange

Mark inbox messages as read, unread or deleted

Geofence

Method
Endpoint
Description
Docs

POST

/rest/3.0/geofence/add

Create a geofence

POST

/rest/3.0/geofence/remove

Delete a geofence by ID

Method
Endpoint
Description
Docs

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?