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

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.

Was this section helpful?

What made this section unhelpful for you?

List channels

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

Query Parameters

beforestring
firstinteger
offsetinteger

Response

200
Object
OK

Response Attributes

contentarray

Show child attributes

created_atstring
descriptionstring
idstring
lang_countinteger
namestring
organization_idstring
updated_atstring
Was this section helpful?

What made this section unhelpful for you?

GET

/channels?before=&first=&offset=

Select
1 curl --location 'https://api.neodeliver.com/channels' \

Response

[
  {
    "content": [
      {
        "description": "",
        "lang": "",
        "name": ""
      }
    ],
    "created_at": "",
    "description": "",
    "id": "",
    "lang_count": null,
    "name": "",
    "organization_id": "",
    "updated_at": ""
  }
]
Was this section helpful?

What made this section unhelpful for you?

Create channel

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

Body Parameters

contentarray

Show child attributes

Response

200
Object
OK

Response Attributes

contentarray

Show child attributes

created_atstring
descriptionstring
idstring
lang_countinteger
namestring
organization_idstring
updated_atstring
Was this section helpful?

What made this section unhelpful for you?

POST

/channels

Select
1 2 3 4 5 6 7 8 9 10 curl --location 'https://api.neodeliver.com/channels' \ --data '{ "content": [ { "description": "", "lang": "", "name": "" } ] }'

Response

{
  "content": [
    {
      "description": "",
      "lang": "",
      "name": ""
    }
  ],
  "created_at": "",
  "description": "",
  "id": "",
  "lang_count": null,
  "name": "",
  "organization_id": "",
  "updated_at": ""
}
Was this section helpful?

What made this section unhelpful for you?

Delete channel

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

Path Parameters

idstring Required

path

Response

200
Object
OK
Was this section helpful?

What made this section unhelpful for you?

DELETE

/channels/{id}

Select
1 curl --location --globoff --request DELETE 'https://api.neodeliver.com/channels/{id}' \

Response

OK
Was this section helpful?

What made this section unhelpful for you?

Get channel

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

Path Parameters

idstring Required

path

Response

200
Object
OK

Response Attributes

contentarray

Show child attributes

created_atstring
descriptionstring
idstring
lang_countinteger
namestring
organization_idstring
updated_atstring
Was this section helpful?

What made this section unhelpful for you?

GET

/channels/{id}

Select
1 curl --location --globoff 'https://api.neodeliver.com/channels/{id}' \

Response

{
  "content": [
    {
      "description": "",
      "lang": "",
      "name": ""
    }
  ],
  "created_at": "",
  "description": "",
  "id": "",
  "lang_count": null,
  "name": "",
  "organization_id": "",
  "updated_at": ""
}
Was this section helpful?

What made this section unhelpful for you?

Update channel

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

Path Parameters

idstring Required

path

Body Parameters

contentarray

Show child attributes

Response

200
Object
OK

Response Attributes

contentarray

Show child attributes

created_atstring
descriptionstring
idstring
lang_countinteger
namestring
organization_idstring
updated_atstring
Was this section helpful?

What made this section unhelpful for you?

PUT

/channels/{id}

Select
1 2 3 4 5 6 7 8 9 10 curl --location --globoff --request PUT 'https://api.neodeliver.com/channels/{id}' \ --data '{ "content": [ { "description": "", "lang": "", "name": "" } ] }'

Response

{
  "content": [
    {
      "description": "",
      "lang": "",
      "name": ""
    }
  ],
  "created_at": "",
  "description": "",
  "id": "",
  "lang_count": null,
  "name": "",
  "organization_id": "",
  "updated_at": ""
}
Was this section helpful?

What made this section unhelpful for you?

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.