API explorerChangelog
API explorer
Changelog

Theme switcher

NeoDeliver API

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

Was this section helpful?

What made this section unhelpful for you?

Base URL

Production:

https://api.neodeliver.com

Language Box

Was this section helpful?

What made this section unhelpful for you?

auth

Was this section helpful?

What made this section unhelpful for you?

Authenticate

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

Body Parameters

client_idstring
client_secretstring
grant_typestring
scopestring

Response

200
Object
OK

Response Attributes

access_tokenstring
expiresinteger
token_typestring
Was this section helpful?

What made this section unhelpful for you?

POST

/auth/token

Select
1 2 3 4 5 6 7 curl --location 'https://api.neodeliver.com/auth/token' \ --data '{ "client_id": "key_1234567890", "client_secret": "**********", "grant_type": "client_credentials", "scope": "*" }'

Response

{
  "access_token": "token",
  "expires": 86400,
  "token_type": "Bearer"
}
Was this section helpful?

What made this section unhelpful for you?

campaigns

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.

channels

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.

contacts

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.

smtp

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.

tags

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.