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.

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.

Was this section helpful?

What made this section unhelpful for you?

Bullk delete contacts

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

Body Parameters

idarray

Show child attributes

Response

200
Object
OK

Response Attributes

countinteger
Was this section helpful?

What made this section unhelpful for you?

DELETE

/contacts

Select
1 2 3 4 5 6 curl --location --request DELETE 'https://api.neodeliver.com/contacts' \ --data '{ "id": [ "" ] }'

Response

{
  "count": null
}
Was this section helpful?

What made this section unhelpful for you?

List contacts

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

Query Parameters

beforestring
bulkIDstring
channelstring
firstinteger
offsetinteger
searchstring
statusstring
tagstring

Response

200
Object
OK

Response Attributes

birthdaystring
bulk_idstring
channel_idsarray

Show child attributes

emailstring
external_idstring

used to map to external systems => unique per org

genderstring
given_namestring
idstring
langstring
last_namestring
metadataobject
namestring
notification_tokensarray

Show child attributes

organization_idstring
phone_numberstring
statusstring
subscribed_atstring
tagsarray

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/contacts?before=&bulkID=&channel=&first=&offset=&search=&status=&tag=

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

Response

[
  {
    "birthday": "",
    "bulk_id": "",
    "channel_ids": [
      ""
    ],
    "email": "",
    "external_id": "",
    "gender": "",
    "given_name": "",
    "id": "",
    "lang": "",
    "last_name": "",
    "metadata": {},
    "name": "",
    "notification_tokens": [
      ""
    ],
    "organization_id": "",
    "phone_number": "",
    "status": "",
    "subscribed_at": "",
    "tags": [
      ""
    ]
  }
]
Was this section helpful?

What made this section unhelpful for you?

Create contact

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

Body Parameters

birthdaystring
emailstring
external_idstring

used to map to external systems => unique per org

genderstring
given_namestring
langstring
last_namestring
metadataobject
notification_tokensarray

Show child attributes

phone_numberstring
tagsarray

Show child attributes

Response

200
Object
OK

Response Attributes

birthdaystring
bulk_idstring
channel_idsarray

Show child attributes

emailstring
external_idstring

used to map to external systems => unique per org

genderstring
given_namestring
idstring
langstring
last_namestring
metadataobject
namestring
notification_tokensarray

Show child attributes

organization_idstring
phone_numberstring
statusstring
subscribed_atstring
tagsarray

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/contacts

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 curl --location 'https://api.neodeliver.com/contacts' \ --data '{ "birthday": "", "email": "", "external_id": "", "gender": "", "given_name": "", "lang": "", "last_name": "", "metadata": {}, "notification_tokens": [ "" ], "phone_number": "", "tags": [ "" ] }'

Response

{
  "birthday": "",
  "bulk_id": "",
  "channel_ids": [
    ""
  ],
  "email": "",
  "external_id": "",
  "gender": "",
  "given_name": "",
  "id": "",
  "lang": "",
  "last_name": "",
  "metadata": {},
  "name": "",
  "notification_tokens": [
    ""
  ],
  "organization_id": "",
  "phone_number": "",
  "status": "",
  "subscribed_at": "",
  "tags": [
    ""
  ]
}
Was this section helpful?

What made this section unhelpful for you?

Delete contact

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

Path Parameters

idstring Required

path

Response

200
Object
OK
Was this section helpful?

What made this section unhelpful for you?

DELETE

/contacts/{id}

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

Response

OK
Was this section helpful?

What made this section unhelpful for you?

Get contact

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

Path Parameters

idstring Required

path

Response

200
Object
OK

Response Attributes

birthdaystring
bulk_idstring
channel_idsarray

Show child attributes

emailstring
external_idstring

used to map to external systems => unique per org

genderstring
given_namestring
idstring
langstring
last_namestring
metadataobject
namestring
notification_tokensarray

Show child attributes

organization_idstring
phone_numberstring
statusstring
subscribed_atstring
tagsarray

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/contacts/{id}

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

Response

{
  "birthday": "",
  "bulk_id": "",
  "channel_ids": [
    ""
  ],
  "email": "",
  "external_id": "",
  "gender": "",
  "given_name": "",
  "id": "",
  "lang": "",
  "last_name": "",
  "metadata": {},
  "name": "",
  "notification_tokens": [
    ""
  ],
  "organization_id": "",
  "phone_number": "",
  "status": "",
  "subscribed_at": "",
  "tags": [
    ""
  ]
}
Was this section helpful?

What made this section unhelpful for you?

Update contact

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

Path Parameters

idstring Required

path

Body Parameters

dataobject

Show child attributes

statusstring

Response

200
Object
OK

Response Attributes

birthdaystring
bulk_idstring
channel_idsarray

Show child attributes

emailstring
external_idstring

used to map to external systems => unique per org

genderstring
given_namestring
idstring
langstring
last_namestring
metadataobject
namestring
notification_tokensarray

Show child attributes

organization_idstring
phone_numberstring
statusstring
subscribed_atstring
tagsarray

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

PATCH

/contacts/{id}

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 curl --location --globoff --request PATCH 'https://api.neodeliver.com/contacts/{id}' \ --data '{ "data": { "birthday": "", "email": "", "external_id": "", "gender": "", "given_name": "", "lang": "", "last_name": "", "metadata": {}, "notification_tokens": [ "" ], "phone_number": "", "tags": [ "" ] }, "status": "" }'

Response

{
  "birthday": "",
  "bulk_id": "",
  "channel_ids": [
    ""
  ],
  "email": "",
  "external_id": "",
  "gender": "",
  "given_name": "",
  "id": "",
  "lang": "",
  "last_name": "",
  "metadata": {},
  "name": "",
  "notification_tokens": [
    ""
  ],
  "organization_id": "",
  "phone_number": "",
  "status": "",
  "subscribed_at": "",
  "tags": [
    ""
  ]
}
Was this section helpful?

What made this section unhelpful for you?

Bulk create contacts

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

Body Parameters

contactsarray

Show child attributes

silentboolean
skip_emptyboolean

Response

200
Object
OK

Response Attributes

array
Was this section helpful?

What made this section unhelpful for you?

POST

/contacts/bulk

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 curl --location 'https://api.neodeliver.com/contacts/bulk' \ --data '{ "contacts": [ { "birthday": "", "email": "", "external_id": "", "gender": "", "given_name": "", "lang": "", "last_name": "", "metadata": {}, "notification_tokens": [ "" ], "phone_number": "", "tags": [ "" ] } ], "silent": false, "skip_empty": false }'

Response

[
  ""
]
Was this section helpful?

What made this section unhelpful for you?

Remove channels from contacts

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

Body Parameters

channel_idarray

Show child attributes

contact_idarray

Show child attributes

Response

200
Object
OK
Was this section helpful?

What made this section unhelpful for you?

DELETE

/contacts/channels

Select
1 2 3 4 5 6 7 8 9 curl --location --request DELETE 'https://api.neodeliver.com/contacts/channels' \ --data '{ "channel_id": [ "" ], "contact_id": [ "" ] }'

Response

OK
Was this section helpful?

What made this section unhelpful for you?

Assign channels to contacts

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

Body Parameters

channel_idarray

Show child attributes

contact_idarray

Show child attributes

replaceboolean

Response

200
Object
OK
Was this section helpful?

What made this section unhelpful for you?

POST

/contacts/channels

Select
1 2 3 4 5 6 7 8 9 10 curl --location 'https://api.neodeliver.com/contacts/channels' \ --data '{ "channel_id": [ "" ], "contact_id": [ "" ], "replace": false }'

Response

OK
Was this section helpful?

What made this section unhelpful for you?

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.