neodeliver

The NeoDeliver API enables seamless integration with our bulk communication platform, providing powerful tools to send and manage messages across email, SMS, and push notifications. Use these endpoints to automate campaigns and synchronise contacts

NeoDeliver API

auth

To interact with the NeoDeliver API, you must first authenticate by calling the Token Generation endpoint using your client_id and client_secret. This will generate an access token that is required for all subsequent API requests. You can generate a new access token at any time and it will expire after 24 hours. Once you generated the access token, you can use it in the Authorization header of your requests (Authorization: Bearer <access_token>). You can generate your client credentials in the API Keys section of your settings (https://app.neodeliver.com/settings/integrations/api).

Authenticate

The Campaigns section allows you to get and use your communication campaigns with ease. Campaigns are at the core of NeoDeliver’s bulk messaging functionality, enabling you to send personalized messages to targeted groups across multiple channels like email, SMS, and push notifications.

campaigns

This section allows you to retrieve a list of all campaigns associated with your account.

List campaigns

This section you to retrieve detailed information about a specific campaign by its unique ID.

Get campaign

This api allows users to initiate the sending of a specific campaign to the desired target audience.

Send campaign

The channels section provides tools to get and manage communication channels used for sending messages. Channels represent the desired message categories (e.g., promotions, newsletter) your contacts subscribed to.

channels

This endpoint allows you to retrieve a list of available communication channels.

List channels

Create a communication channel to be used in sending messages to contacts.

Create channel

This endpoint allows you to remove a specific communication channel within your account.

Delete channel

This endpoint allows you to retrieve detailed information about a specific communication channel within your account.

Get channel

This section allows you to update the communication channel settings for a specific ID.

Update channel

The Contacts section allows you to manage your audience by storing and organizing recipient information. Contacts serve as the foundation for personalized and targeted communication, enabling you to deliver messages to the right people at the right time.

contacts

This section allows you to remove a specific contacts from your account.

Bullk delete contacts

This endpoint allows users to retrieve a comprehensive list of contacts associated with your account.

List contacts

This section allows you to create new contacts within the account.

Create contact

With this endpoint you can effortlessly remove a contact from your account.

Delete contact

This endpoint allows you to retrieve specific contact information by their unique ID.

Get contact

This endpoint allows you to modify and update the details of a contact within the system.

Update contact

With this endpoint, you can efficiently add multiple contacts to your account at once.

Bulk create contacts

With this endpoint, you can easily remove specific communication channels associated with each provided contact.

Remove channels from contacts

This endpoint allows you to easily associate specific communication channels with the given contacts.

Assign channels to contacts

The SMTP section allows you to manage the domain names used for sending emails through the platform. Proper domain configuration ensures reliable delivery, improves email reputation, and helps maintain compliance with industry standards.

smtp

This endpoint allows you to retrieve a comprehensive list of domain names associated with your account.

List domains

This section you to add a new domain name to your mailing service.

Add new domain

This endpoint allows you to remove a specific domain associated with your mailing server.

Delete domain

This endpoint allows you to retrieve information about a specific domain by providing its host name.

Get domain

The Tags section allows you to create and manage tags that can be associated with contacts. Tags serve as powerful markers for categorizing and identifying behaviors, preferences, or attributes, enabling you to target your campaigns with precision and improve overall engagement.

List tags

This endpoint allows you to add a new tag to your account.

Create tag

This endpoint allows you to efficiently remove a specific tag from your account.

Delete tag

Default

Sections