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.

Was this section helpful?

What made this section unhelpful for you?

List campaigns

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

Query Parameters

beforestring
draftboolean
firstinteger
namestring
offsetinteger
typestring

Response

200
Object
OK

Response Attributes

created_atstring
descriptionstring
draftboolean
idstring
namestring
next_schedulestring
organization_idstring
recipientsarray

Show child attributes

tagsarray

TODO if provided validate tags exists

Show child attributes

typestring
updated_atstring
Was this section helpful?

What made this section unhelpful for you?

GET

/campaigns?before=&draft=&first=&name=&offset=&type=

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

Response

[
  {
    "created_at": "",
    "description": "",
    "draft": false,
    "id": "",
    "name": "",
    "next_schedule": "",
    "organization_id": "",
    "recipients": [
      ""
    ],
    "tags": [
      ""
    ],
    "type": "",
    "updated_at": ""
  }
]
Was this section helpful?

What made this section unhelpful for you?

Get campaign

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

Path Parameters

idstring Required

path

Response

200
Object
OK

Response Attributes

created_atstring
descriptionstring
draftboolean
idstring
namestring
next_schedulestring
organization_idstring
recipientsarray

Show child attributes

tagsarray

TODO if provided validate tags exists

Show child attributes

typestring
updated_atstring
Was this section helpful?

What made this section unhelpful for you?

GET

/campaigns/{id}

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

Response

{
  "created_at": "",
  "description": "",
  "draft": false,
  "id": "",
  "name": "",
  "next_schedule": "",
  "organization_id": "",
  "recipients": [
    ""
  ],
  "tags": [
    ""
  ],
  "type": "",
  "updated_at": ""
}
Was this section helpful?

What made this section unhelpful for you?

Send campaign

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

Path Parameters

idstring Required

path

Body Parameters

contact_idstring
emailstring
phone_numberstring
tokensarray

Show child attributes

Response

200
Object
OK

Response Attributes

bulkboolean
campaign_idstring
contact_idstring
created_atstring
emailstring
idstring
langstring
notification_tokensarray

Show child attributes

organization_idstring
parent_idstring
phone_numberstring
sourceobject

Show child attributes

stateobject

Show child attributes

typestring
updated_atstring
Was this section helpful?

What made this section unhelpful for you?

POST

/campaigns/{id}/send

Select
1 2 3 4 5 6 7 8 9 curl --location --globoff 'https://api.neodeliver.com/campaigns/{id}/send' \ --data '{ "contact_id": "", "email": "", "phone_number": "", "tokens": [ "" ] }'

Response

{
  "bulk": false,
  "campaign_id": "",
  "contact_id": "",
  "created_at": "",
  "email": "",
  "id": "",
  "lang": "",
  "notification_tokens": [
    ""
  ],
  "organization_id": "",
  "parent_id": "",
  "phone_number": "",
  "source": {
    "event_id": "",
    "type": "",
    "user_id": ""
  },
  "state": {
    "bounced": false,
    "clicked": false,
    "cost": null,
    "delivered": false,
    "failed": false,
    "opened": false,
    "queued_at": "",
    "sent": false
  },
  "type": "",
  "updated_at": ""
}
Was this section helpful?

What made this section unhelpful for you?

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.