Datananas

Introduction

Datananas' API is organized around REST. All API routes use HTTP verbs and responses use HTTP response codes.
Responses are formatted with JSON.
All requests should be made over HTTPS on the API base url https://api.datananas.com

API Status

You can check API status here : https://status.datananas.com

Getting started

You can test API endpoints live in the documentation.

If you already have a token (otherwise, please refer to the Authentication section), try it by sending a first API request:

Go to the Get connected user route
Click on the "Try it" button
Copy your Bearer token and hit "Enter"

You should see your user's information appear on the right :)

Suggest Edits

Authentication

In order to authenticate to the API, you will need an access token.

Before getting one, please make sure to know why you need to use our API.

Use it for your own account

You can get in touch with us at support@datananas.com to get an access_token

Connect your application with Datananas

If your want to create an integration that will be accessible to your users, please us our Oauth2 authentication flow

You can get in touch with us to set-up your partner account support@datananas.com and get your client_id and client_secret

Authentication

Please get in touch with our team to get an access token using support@datananas.com

Access Level

Tokens contain a specific set of scopes that give you access to certain resources, with a certain access level.
For example, we can create a token for a specific integration that will be able to list contacts in the whole company, only get campaigns created by one user, and cannot create new campaigns.

How to authenticate

You need to provide your api token in the Headers :

JSON

{
  "Authorization" : "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.etc..."
}

Suggest Edits

Pagination

API routes that return a list of resources are paginated.
If no resource correspond to the query for a filter route, it will return an empty array.

Here's an example of how resources are paginated :

JSON

page: {
	page: 2,
 	pages: 10,
	total: 200
}

You can pass a parameter with the page number you want to get

Suggest Edits

Projected fields

Fields with an id are not projected by default, by you can ask the API to do so by passing a projectionFields parameter.

Here's a sample Campaign with no projected fields :

JSON

{
  _id: "123456789abcfef1234567890",
  name: "My campaign",
  userId: "abc123456789fef1234567890",
  etc...
}

And with the populated user :

JSON

{
  _id: "123456789abcfef1234567890",
  name: "My campaign",
  userId: {
    _id: "abc123456789fef1234567890",
    first_name: "Romain",
    last_name: "Simon"
  },
  etc...
}

Here are infos available in populated fields for different resources :

JSON

campaigns:
    userId: {
        _id,
        first_name,
        last_name
    }
}

contacts:
    userId: {
        first_name,
        last_name
    },
    listId: {
        list_name,
    }
}

lists:
    userId: {
        _id,
        first_name,
        last_name
    }
}

messages:
    campaignId: {
        _id,
        name
    },
    contactFields: {
        _id,
        first_name,
        last_name,
        email
    }
}

templates:
    userId: {
        first_name,
        last_name
    }
}

variables:
    userId: {
        first_name,
        last_name
    }
}

Suggest Edits

Error codes

Generic Errors

Code

Name

Description

500

Internal Error

An unexpected error occured

503

Service Unavailable

The service is currently not available. This can be the case for maintenance : for example if we detect a critical bug in a route, we might disable it temporary.

400

Bad Request

Your request is not properly formatted

401

Unauthorized

You don't have access to this resource. This can happen if you did not provide a token, your token has expired, or you don't have the required access level for this resource.

403

Forbidden

You don't have the required access rights for this resource

404

Not Found

You requested a resource that does not exists

409

Conflict

There is a conflict and you request can't be processed. For example, this can happen if you try to edit a running campaign.

Suggest Edits

Email guessing

Suggest Edits

Company to domain

Guessing which email domain will match a company name
For example: Datananas will return datananas.com

gethttps://api.datananas.com/accounts/domain

curl --request GET \
  --url 'https://api.datananas.com/accounts/domain?company_name=company_name'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.datananas.com/accounts/domain',
  qs: { company_name: 'company_name' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/accounts/domain?company_name=company_name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/accounts/domain?company_name=company_name");

xhr.send(data);

import requests

url = "https://api.datananas.com/accounts/domain"

querystring = {"company_name":"company_name"}

response = requests.request("GET", url, params=querystring)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

company_name

string

required

Filter domains by company_name

country_code

string

Country code (fr, en)

Response

A list of possible domains with their probability score

Suggest Edits

Guess email

Find possible email adresses for a contact with first name, last name and domain
For example, Romain + Simon + datananas.com will return romain@datananas.com

gethttps://api.datananas.com/accounts/email

curl --request GET \
  --url 'https://api.datananas.com/accounts/email?first_name=first_name&last_name=last_name&domain=domain'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.datananas.com/accounts/email',
  qs:
   { first_name: 'first_name',
     last_name: 'last_name',
     domain: 'domain' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/accounts/email?first_name=first_name&last_name=last_name&domain=domain")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/accounts/email?first_name=first_name&last_name=last_name&domain=domain");

xhr.send(data);

import requests

url = "https://api.datananas.com/accounts/email"

querystring = {"first_name":"first_name","last_name":"last_name","domain":"domain"}

response = requests.request("GET", url, params=querystring)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

first_name

string

required

First name

last_name

string

required

Last name

domain

string

required

Domain name

country_code

string

Country code (fr, en)

Response

A list of possible emails with their probability score

Suggest Edits

Activities

Suggest Edits

Find activites

Searching users and contacts activities.
User activities include any action in the software.
Contact activities include opening emails, clicking emails, unsubscribing, ...

gethttps://api.datananas.com/activities

curl --request GET \
  --url https://api.datananas.com/activities

var request = require("request");

var options = { method: 'GET', url: 'https://api.datananas.com/activities' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/activities")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/activities");

xhr.send(data);

import requests

url = "https://api.datananas.com/activities"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

type

string

Type of activity

contactId

objectId

Id of the contact to filter

campaignId

objectId

Id of the campaign to filter

userId

objectId

Id of the user to filter

companyId

objectId

Id of the company to filter

createdAt

array of strings

Filter contacts by added date
Takes an array of two items, first item is dateStart and second is dateEnd.
Dates must be in ISO8601 format

Response

A list of activities

Suggest Edits

Billing

Suggest Edits

Subscribe

Add a subscription to the account

posthttps://api.datananas.com/billing/subscribe

curl --request POST \
  --url https://api.datananas.com/billing/subscribe

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.datananas.com/billing/subscribe' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/billing/subscribe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.datananas.com/billing/subscribe");

xhr.send(data);

import requests

url = "https://api.datananas.com/billing/subscribe"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Body Params

plan

string

Subscription plan (starter, team, team_plus, enterprise)

period

string

Subscription period (monthly, yearly)

card

object

Credit card infos

card.number

number

Credit card number

card.exp_month

number

Credit card expiration month

card.exp_year

number

Credit card expiration year

card.cvc

number

Credit card cvc

coupon

string

An optional coupon code

tax_percent

string

An optional tax percent

Response

The subscription as been added

Suggest Edits

Blacklist

Suggest Edits

Add to blacklist

Creates a new blacklisted email or domain.
Any contact having a matching email will not be contacted.

posthttps://api.datananas.com/blacklist

curl --request POST \
  --url https://api.datananas.com/blacklist

var request = require("request");

var options = { method: 'POST', url: 'https://api.datananas.com/blacklist' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/blacklist")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.datananas.com/blacklist");

xhr.send(data);

import requests

url = "https://api.datananas.com/blacklist"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Body Params

reason

string

required

The reason of the blacklisted entry

entries

array

required

list of emails and domains to blacklist

groupId

string

The group owning blacklisted entry

Response

Newly created blacklists entries

blacklist	array
errors	array

Suggest Edits

Find in blacklist

Search blacklisted email or domains

gethttps://api.datananas.com/blacklist

curl --request GET \
  --url https://api.datananas.com/blacklist

var request = require("request");

var options = { method: 'GET', url: 'https://api.datananas.com/blacklist' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/blacklist")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/blacklist");

xhr.send(data);

import requests

url = "https://api.datananas.com/blacklist"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

filter

string

A filter or a list of filters

Response

A list of blacklisted entries

Suggest Edits

Remove from blacklist

Delete a blacklisted email or domain

deletehttps://api.datananas.com/blacklist/id

curl --request DELETE \
  --url https://api.datananas.com/blacklist/id

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.datananas.com/blacklist/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/blacklist/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.datananas.com/blacklist/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/blacklist/id"

response = requests.request("DELETE", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The blacklisted entry's ID

Response

The blacklisted entry has been deleted

message	string
status	number
code	number

message	string
status	number
code	number

Suggest Edits

Calls

Suggest Edits

Get token

Generate a Twilio Client capability token

gethttps://api.datananas.com/calls/token

curl --request GET \
  --url https://api.datananas.com/calls/token

var request = require("request");

var options = { method: 'GET', url: 'https://api.datananas.com/calls/token' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/calls/token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/calls/token");

xhr.send(data);

import requests

url = "https://api.datananas.com/calls/token"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Response

Twilio token and phones

message	string
status	number
code	number

Suggest Edits

Send calls

Route outbound calls

posthttps://api.datananas.com/calls/voice

curl --request POST \
  --url https://api.datananas.com/calls/voice

var request = require("request");

var options = { method: 'POST', url: 'https://api.datananas.com/calls/voice' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/calls/voice")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.datananas.com/calls/voice");

xhr.send(data);

import requests

url = "https://api.datananas.com/calls/voice"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Body Params

ApplicationSid

string

Id of the Twilio application

CallSid

string

Id of the call

AccountSid

string

Id of the Twilio account or customer subaccount

number

string

Phone number to call

callerId

string

Phone number that sends the call

Response

Twilio verbs (TwiML)

Suggest Edits

Contacts

Suggest Edits

Add contacts in sequence

Add contacts in a sequence. You can add contacts with multiple methods:

By providing an array of contactIds
By adding all contacts matching a saved search, with searchId
By adding all contacts in a list, with listId

There are also several ways to spread sequence steps over time, and across a sales team:

Selecting a drip will spread the sequence first step over time.
For example, adding 200 contacts with a drip of 20 will allow you to get in touch with 20 new contacts per open day.
Selecting multiple senderIds will allow you to spread touches cross these users:
- If you select an owner distribution, each contact will be contact by its previously defined owner
- If you select a `random distribution, all contact will be randomly and equally distributed across senders

You can add up to 2500 contacts at once.

patchhttps://api.datananas.com/campaigns/:id/contacts

curl --request PATCH \
  --url https://api.datananas.com/campaigns/:id/contacts

var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.datananas.com/campaigns/:id/contacts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/campaigns/:id/contacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.datananas.com/campaigns/:id/contacts");

xhr.send(data);

import requests

url = "https://api.datananas.com/campaigns/:id/contacts"

response = requests.request("PATCH", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

contactIds

array of strings

The contact ids to delete

filter

string

Filter by keyword

listId

objectId

Filter contacts by list. Should be a listId or list of listId

userId

objectId

Filter contacts by owner. Should be a userId or list of userId

companySize

string

Filter contacts by company size

companyIndustry

string

Filter contacts by company industry

city

string

Filter contacts by city

country

string

Filter contacts by country

role

string

Filter contacts by role

status

string

Filter contacts by status

dateAdded

array of strings

Filter contacts by added ISO8601 date. Takes an array of two items were the first index is dateStart and the second is dateEnd.

campaignId

objectId

Filter contacts by campaign. Can be a single campaignId or multiple campaignId

isActiveInCampaign

boolean

Filter contacts by campaign activity

email

string

Filter contacts by email

lastEmailCategory

string

Filter contacts by last email category

Body Params

senderIds

array of strings

An array of one of more user ids that will be the senders

drip

number

The number of new contacts per day to get in touch with

dateStart

string

The ISO8601 format date when to start adding contacts.
The date must be in UTC timezone.

searchId

objectId

An id of a saved search

listId

objectId

An id of a list

contactIds

array of strings

An array of contacts id

distribution

string

When activating drip with multiple senders, distribution defines how contacts are distributed between these senders.
Random means contacts are evely distributed randomly across senders.
Owner means the sender will be the contact's owner, and the distribution has already been made manually

Response

Emails are being scheduled

contacts	number The number of contacts added to the campaign

message	string
status	number
code	number

message	string
status	number
code	number

message	string
status	number
code	number

Suggest Edits

Unsubscribe contact

Unsubscribe a single contact from a sequence

deletehttps://api.datananas.com/campaigns/id/contacts/contactId

curl --request DELETE \
  --url https://api.datananas.com/campaigns/id/contacts/contactId

var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.datananas.com/campaigns/id/contacts/contactId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/campaigns/id/contacts/contactId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.datananas.com/campaigns/id/contacts/contactId");

xhr.send(data);

import requests

url = "https://api.datananas.com/campaigns/id/contacts/contactId"

response = requests.request("DELETE", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The sequence's ID

contactId

string

required

The contact's ID

Response

The contact has been unsubscribed and pending emails removed

linked	boolean Tells if the contact is still linked to the sequence or not
removedEmails	number The number of removed pending emails removed

message	string
status	number
code	number

message	string
status	number
code	number

Suggest Edits

Create a contact

Create a new contact.
If you new to create multiple contacts at once, use the Bulk create route instead.

posthttps://api.datananas.com/contacts

curl --request POST \
  --url https://api.datananas.com/contacts

var request = require("request");

var options = { method: 'POST', url: 'https://api.datananas.com/contacts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.datananas.com/contacts");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Body Params

listId

string

ID of the list

email

string

Email of the contact (a valid email address)

phone

string

Phone number

first_name

string

First name (length => min=1, max=255)

last_name

string

Last name (length => min=1, max=255)

company_name

string

Company name (length => min=1, max=255)

lang

string

Language (Valid ISO-639-1)

city

string

City

country

string

Country

role

string

Job title of the contact in his company

education_school

string

School where the contact had studied

education_diploma

string

Last diploma

education_major

string

Major of his degree

company_industry

string

Industry of the company

company_size

string

Size of the company

vars

object

Contains variables values as a free form object to store additional information

Response

The contact has been create successfully

first_name	string The first name of the prospect
last_name	string The last name of the prospect
picture	string The gravatar url
status	string The lead status
lang	string The prospect's language
city	string The city where the prospect live
country	string The country where the prospect live
email	string The email address of the prospect
phone	string The phone number of the prospect
email_status	string The status of the email
source	string Where does this prospect comes from
email_source	string Where does the email come from
role	string The prospect's role in its company
deleted	boolean Does the contact has been removed
education_school	string The school/university in which the contact have studied
education_diploma	string The diploma in got in its university
education_major	string The major of its diploma
company_name	string The name of the company where's currently working
company_industry	string The category of the company
company_size	string The number of employeen in the company
unsubscribed	boolean Does the prospects explicitly asked us to not contact him ? It happens when the prospect click on the unsubscribe link. The prospect won't be contacted anymore
vars	object An hash map of custom properties of this contact. These keys can be used in an email template.
listId	string The list in which the contact is (ObjectId)
userId	string The owner id of this contact (ObjectId)
customerId	string The id of the company (ObjectId)
groupId	string The group (ObjectId)
date_added	string date of creation
updatedAt	string last update date
collectedAt	string Date at which the contact has been collected. This date is specified manually by the user when creating contacts.
customKeywords	string list of concatenated custom vars
email_score	number The scope of the email address
icps	object A map that contain ICP document ids, each id has an object as value with a score and a date
lastEmailCategory	string The category of the last email sent by the contact

message	string
status	number
code	number

Suggest Edits

Filter contact based on multiple criteria

gethttps://api.datananas.com/contacts

curl --request GET \
  --url https://api.datananas.com/contacts

var request = require("request");

var options = { method: 'GET', url: 'https://api.datananas.com/contacts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/contacts");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

filter

string

Filter by keyword

id

objectId

Filter contacts by id

listId

objectId

Filter contacts by list. Should be a listId or list of listId

userId

objectId

Filter contacts by owner. Should be a userId or list of userId

companySize

string

Filter contacts by company size

companyIndustry

string

Filter contacts by company industry

city

string

Filter contacts by city

country

string

Filter contacts by country

role

string

Filter contacts by role

status

string

Filter contacts by status

dateAdded

array of strings

Filter contacts by added ISO8601 date. Takes an array of two items were the first index is dateStart and the second is dateEnd.

campaignId

objectId

Filter contacts by campaign. Can be a single campaignId or multiple campaignId

isActiveInCampaign

boolean

Filter contacts by campaign activity

page

integer

Page to retrieve

limit

integer

Number of results per page (limited to 50)

email

string

Filter contacts by email

lastEmailCategory

string

Filter contacts by last email category

Response

A list of contact that match

Suggest Edits

Delete multiple contacts

Delete multiple contacts by filters

deletehttps://api.datananas.com/contacts

curl --request DELETE \
  --url https://api.datananas.com/contacts

var request = require("request");

var options = { method: 'DELETE', url: 'https://api.datananas.com/contacts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.datananas.com/contacts");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts"

response = requests.request("DELETE", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

contactIds

array of strings

The contact ids to delete

filter

string

Filter by keyword

listId

objectId

Filter contacts by list. Should be a listId or list of listId

userId

objectId

Filter contacts by owner. Should be a userId or list of userId

companySize

string

Filter contacts by company size

companyIndustry

string

Filter contacts by company industry

city

string

Filter contacts by city

country

string

Filter contacts by country

role

string

Filter contacts by role

status

string

Filter contacts by status

dateAdded

array of strings

Filter contacts by added ISO8601 date. Takes an array of two items were the first index is dateStart and the second is dateEnd.

campaignId

objectId

Filter contacts by campaign. Can be a single campaignId or multiple campaignId

isActiveInCampaign

boolean

Filter contacts by campaign activity

email

string

Filter contacts by email

lastEmailCategory

string

Filter contacts by last email category

Response

Some or all contacts have been deleted successfully

success	boolean Has the contact been deleted? Should be true

message	string
status	number
code	number

message	string
status	number
code	number

Suggest Edits

Update multiple contacts

Update status, list or user of multiple contacts

patchhttps://api.datananas.com/contacts

curl --request PATCH \
  --url https://api.datananas.com/contacts

var request = require("request");

var options = { method: 'PATCH', url: 'https://api.datananas.com/contacts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.datananas.com/contacts");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts"

response = requests.request("PATCH", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

contactIds

array of strings

The contact ids to delete

filter

string

Filter by keyword

listId

objectId

Filter contacts by list. Should be a listId or list of listId

userId

objectId

Filter contacts by owner. Should be a userId or list of userId

companySize

string

Filter contacts by company size

companyIndustry

string

Filter contacts by company industry

city

string

Filter contacts by city

country

string

Filter contacts by country

role

string

Filter contacts by role

status

string

Filter contacts by status

dateAdded

array of strings

Filter contacts by added ISO8601 date. Takes an array of two items were the first index is dateStart and the second is dateEnd.

campaignId

objectId

Filter contacts by campaign. Can be a single campaignId or multiple campaignId

isActiveInCampaign

boolean

Filter contacts by campaign activity

email

string

Filter contacts by email

lastEmailCategory

string

Filter contacts by last email category

Body Params

contactIds

array of strings

An array of contacts id

listId

objectId

Updates to apply

userId

objectId

status

string

Response

The contacts have been updated successfully

contacts	number The number of contacts updated

message	string
status	number
code	number

Suggest Edits

Delete a contact

Delete a single contact by id

deletehttps://api.datananas.com/contacts/id

curl --request DELETE \
  --url https://api.datananas.com/contacts/id

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.datananas.com/contacts/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.datananas.com/contacts/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts/id"

response = requests.request("DELETE", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

objectId

required

The contact id to delete

Response

The contact has been deleted successfully

success	boolean Has the contact been deleted? Should be true

message	string
status	number
code	number

message	string
status	number
code	number

Suggest Edits

Get a contact

Get a contact by id

gethttps://api.datananas.com/contacts/id

curl --request GET \
  --url https://api.datananas.com/contacts/id

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.datananas.com/contacts/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/contacts/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts/id"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The contact id

Response

A contact

first_name	string The first name of the prospect
last_name	string The last name of the prospect
picture	string The gravatar url
status	string The lead status
lang	string The prospect's language
city	string The city where the prospect live
country	string The country where the prospect live
email	string The email address of the prospect
phone	string The phone number of the prospect
email_status	string The status of the email
source	string Where does this prospect comes from
email_source	string Where does the email come from
role	string The prospect's role in its company
deleted	boolean Does the contact has been removed
education_school	string The school/university in which the contact have studied
education_diploma	string The diploma in got in its university
education_major	string The major of its diploma
company_name	string The name of the company where's currently working
company_industry	string The category of the company
company_size	string The number of employeen in the company
unsubscribed	boolean Does the prospects explicitly asked us to not contact him ? It happens when the prospect click on the unsubscribe link. The prospect won't be contacted anymore
vars	object An hash map of custom properties of this contact. These keys can be used in an email template.
listId	string The list in which the contact is (ObjectId)
userId	string The owner id of this contact (ObjectId)
customerId	string The id of the company (ObjectId)
groupId	string The group (ObjectId)
date_added	string date of creation
updatedAt	string last update date
collectedAt	string Date at which the contact has been collected. This date is specified manually by the user when creating contacts.
customKeywords	string list of concatenated custom vars
email_score	number The scope of the email address
icps	object A map that contain ICP document ids, each id has an object as value with a score and a date
lastEmailCategory	string The category of the last email sent by the contact

Suggest Edits

Update contact

Update an existing contact

patchhttps://api.datananas.com/contacts/id

curl --request PATCH \
  --url https://api.datananas.com/contacts/id

var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.datananas.com/contacts/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.datananas.com/contacts/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts/id"

response = requests.request("PATCH", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The id of the contact

Body Params

email

string

The new email address

first_name

string

The new first name

last_name

string

The new last name

status

string

The new status

picture

string

The url of the new picture

linkedinurl

string

The url of the Linkedin profile

lang

string

The language of the contact

city

string

The city where the contact lives/works

country

string

The country where the contact lives/works

role

string

The role of the contact in its company

education_school

string

The school where the contact had studied

education_diploma

string

The last diploma of the contact

education_major

string

The major of his degree

company_name

string

The name of the company

company_industry

string

The company type, sector

company_size

string

The size of the company

vars

object

A free form object to store additional information

Response

The contact has been updated successfully

first_name	string The first name of the prospect
last_name	string The last name of the prospect
picture	string The gravatar url
status	string The lead status
lang	string The prospect's language
city	string The city where the prospect live
country	string The country where the prospect live
email	string The email address of the prospect
phone	string The phone number of the prospect
email_status	string The status of the email
source	string Where does this prospect comes from
email_source	string Where does the email come from
role	string The prospect's role in its company
deleted	boolean Does the contact has been removed
education_school	string The school/university in which the contact have studied
education_diploma	string The diploma in got in its university
education_major	string The major of its diploma
company_name	string The name of the company where's currently working
company_industry	string The category of the company
company_size	string The number of employeen in the company
unsubscribed	boolean Does the prospects explicitly asked us to not contact him ? It happens when the prospect click on the unsubscribe link. The prospect won't be contacted anymore
vars	object An hash map of custom properties of this contact. These keys can be used in an email template.
listId	string The list in which the contact is (ObjectId)
userId	string The owner id of this contact (ObjectId)
customerId	string The id of the company (ObjectId)
groupId	string The group (ObjectId)
date_added	string date of creation
updatedAt	string last update date
collectedAt	string Date at which the contact has been collected. This date is specified manually by the user when creating contacts.
customKeywords	string list of concatenated custom vars
email_score	number The scope of the email address
icps	object A map that contain ICP document ids, each id has an object as value with a score and a date
lastEmailCategory	string The category of the last email sent by the contact

message	string
status	number
code	number

message	string
status	number
code	number

Suggest Edits

List owners

List owners of some contacts

gethttps://api.datananas.com/contacts/owners

curl --request GET \
  --url https://api.datananas.com/contacts/owners

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.datananas.com/contacts/owners' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts/owners")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/contacts/owners");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts/owners"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

contactIds

array of strings

The contact ids to delete

filter

string

Filter by keyword

listId

objectId

Filter contacts by list. Should be a listId or list of listId

userId

objectId

Filter contacts by owner. Should be a userId or list of userId

companySize

string

Filter contacts by company size

companyIndustry

string

Filter contacts by company industry

city

string

Filter contacts by city

country

string

Filter contacts by country

role

string

Filter contacts by role

status

string

Filter contacts by status

dateAdded

array of strings

Filter contacts by added ISO8601 date. Takes an array of two items were the first index is dateStart and the second is dateEnd.

campaignId

objectId

Filter contacts by campaign. Can be a single campaignId or multiple campaignId

isActiveInCampaign

boolean

Filter contacts by campaign activity

page

integer

Page to retrieve

limit

integer

Number of results per page (limited to 50)

email

string

Filter contacts by email

lastEmailCategory

string

Filter contacts by last email category

Response

A list of user that match with the number of contacts owned

Suggest Edits

Get pipeline

Gives a count of the number of contacts by status in the funnel/pipeline

gethttps://api.datananas.com/contacts/pipeline

curl --request GET \
  --url https://api.datananas.com/contacts/pipeline

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.datananas.com/contacts/pipeline' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts/pipeline")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/contacts/pipeline");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts/pipeline"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Response

Stats for the requested period of the company

Suggest Edits

Get contacts static values

Get contacts list of static values.
If the requested field is a value list like status or companyIndustry, all values are retrieved without pagination.

gethttps://api.datananas.com/contacts/values

curl --request GET \
  --url 'https://api.datananas.com/contacts/values?field=field'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.datananas.com/contacts/values',
  qs: { field: 'field' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts/values?field=field")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/contacts/values?field=field");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts/values"

querystring = {"field":"field"}

response = requests.request("GET", url, params=querystring)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

field

string

required

Field values to fetch. Must be a field from GET /contacts endpoint

filter

string

Filter results by name. Filter is case-insensitive

page

integer

Page to retrieve.

limit

integer

Number of results per page (limited to 50)

Response

A list of contact that match

Suggest Edits

Get timeline

Get a contact timeline of events including sent emails, reveiced emails, tasks and notes

gethttps://api.datananas.com/contacts/id/timeline

curl --request GET \
  --url https://api.datananas.com/contacts/id/timeline

var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.datananas.com/contacts/id/timeline' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts/id/timeline")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/contacts/id/timeline");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts/id/timeline"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The contact id

Query Params

page

integer

Page to retrieve

limit

integer

Number of results per page (limited to 50)

entities

array of strings

List of entities to fetch (defaults to all)

time

string

Requested time.

Response

Contact timeline

first_name	string The first name of the prospect
last_name	string The last name of the prospect
picture	string The gravatar url
status	string The lead status
lang	string The prospect's language
city	string The city where the prospect live
country	string The country where the prospect live
email	string The email address of the prospect
phone	string The phone number of the prospect
email_status	string The status of the email
source	string Where does this prospect comes from
email_source	string Where does the email come from
role	string The prospect's role in its company
deleted	boolean Does the contact has been removed
education_school	string The school/university in which the contact have studied
education_diploma	string The diploma in got in its university
education_major	string The major of its diploma
company_name	string The name of the company where's currently working
company_industry	string The category of the company
company_size	string The number of employeen in the company
unsubscribed	boolean Does the prospects explicitly asked us to not contact him ? It happens when the prospect click on the unsubscribe link. The prospect won't be contacted anymore
vars	object An hash map of custom properties of this contact. These keys can be used in an email template.
listId	string The list in which the contact is (ObjectId)
userId	string The owner id of this contact (ObjectId)
customerId	string The id of the company (ObjectId)
groupId	string The group (ObjectId)
date_added	string date of creation
updatedAt	string last update date
collectedAt	string Date at which the contact has been collected. This date is specified manually by the user when creating contacts.
customKeywords	string list of concatenated custom vars
email_score	number The scope of the email address
icps	object A map that contain ICP document ids, each id has an object as value with a score and a date
lastEmailCategory	string The category of the last email sent by the contact

Suggest Edits

Check contacts

Checks which contacts already exists before creating them in bulk

posthttps://api.datananas.com/contacts/bulk/check

curl --request POST \
  --url https://api.datananas.com/contacts/bulk/check

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.datananas.com/contacts/bulk/check' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts/bulk/check")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.datananas.com/contacts/bulk/check");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts/bulk/check"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

replaceList

boolean

If set to true, existing contacts will be moved to the list

Body Params

contacts

array of objects

listId

email

phone

first_name

last_name

company_name

lang

city

country

role

education_school

education_diploma

education_major

company_industry

company_size

vars

Response

The contactshave been checked

first_name	string The first name of the prospect
last_name	string The last name of the prospect
picture	string The gravatar url
status	string The lead status
lang	string The prospect's language
city	string The city where the prospect live
country	string The country where the prospect live
email	string The email address of the prospect
phone	string The phone number of the prospect
email_status	string The status of the email
source	string Where does this prospect comes from
email_source	string Where does the email come from
role	string The prospect's role in its company
deleted	boolean Does the contact has been removed
education_school	string The school/university in which the contact have studied
education_diploma	string The diploma in got in its university
education_major	string The major of its diploma
company_name	string The name of the company where's currently working
company_industry	string The category of the company
company_size	string The number of employeen in the company
unsubscribed	boolean Does the prospects explicitly asked us to not contact him ? It happens when the prospect click on the unsubscribe link. The prospect won't be contacted anymore
vars	object An hash map of custom properties of this contact. These keys can be used in an email template.
listId	string The list in which the contact is (ObjectId)
userId	string The owner id of this contact (ObjectId)
customerId	string The id of the company (ObjectId)
groupId	string The group (ObjectId)
date_added	string date of creation
updatedAt	string last update date
collectedAt	string Date at which the contact has been collected. This date is specified manually by the user when creating contacts.
customKeywords	string list of concatenated custom vars
email_score	number The scope of the email address
icps	object A map that contain ICP document ids, each id has an object as value with a score and a date
lastEmailCategory	string The category of the last email sent by the contact

Suggest Edits

Bulk create contacts

Create multiple contacts at once using bulk create.
If you intend to create large amounts of contacts, please divide your contacts in smaller chunks

posthttps://api.datananas.com/contacts/bulk

curl --request POST \
  --url https://api.datananas.com/contacts/bulk

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.datananas.com/contacts/bulk' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.datananas.com/contacts/bulk");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts/bulk"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

replaceList

boolean

If set to true, existing contacts will be moved to the list

Body Params

list

object

list.name

string

Name of the new list (if listId is not provided)

list.listId

objectId

Id of the list where contacts will be added (if name is not provided)

contacts

array of objects

listId

email

phone

first_name

last_name

company_name

lang

city

country

role

education_school

education_diploma

education_major

company_industry

company_size

vars

Response

The contacts have been created and/or updated successfully

first_name	string The first name of the prospect
last_name	string The last name of the prospect
picture	string The gravatar url
status	string The lead status
lang	string The prospect's language
city	string The city where the prospect live
country	string The country where the prospect live
email	string The email address of the prospect
phone	string The phone number of the prospect
email_status	string The status of the email
source	string Where does this prospect comes from
email_source	string Where does the email come from
role	string The prospect's role in its company
deleted	boolean Does the contact has been removed
education_school	string The school/university in which the contact have studied
education_diploma	string The diploma in got in its university
education_major	string The major of its diploma
company_name	string The name of the company where's currently working
company_industry	string The category of the company
company_size	string The number of employeen in the company
unsubscribed	boolean Does the prospects explicitly asked us to not contact him ? It happens when the prospect click on the unsubscribe link. The prospect won't be contacted anymore
vars	object An hash map of custom properties of this contact. These keys can be used in an email template.
listId	string The list in which the contact is (ObjectId)
userId	string The owner id of this contact (ObjectId)
customerId	string The id of the company (ObjectId)
groupId	string The group (ObjectId)
date_added	string date of creation
updatedAt	string last update date
collectedAt	string Date at which the contact has been collected. This date is specified manually by the user when creating contacts.
customKeywords	string list of concatenated custom vars
email_score	number The scope of the email address
icps	object A map that contain ICP document ids, each id has an object as value with a score and a date
lastEmailCategory	string The category of the last email sent by the contact

message	string
status	number
code	number

Suggest Edits

Create a contact's note

Create a new contact's note

posthttps://api.datananas.com/contacts/contactId/notes

curl --request POST \
  --url https://api.datananas.com/contacts/contactId/notes

var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.datananas.com/contacts/contactId/notes' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts/contactId/notes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.datananas.com/contacts/contactId/notes");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts/contactId/notes"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

contactId

objectId

required

The contact id

Body Params

title

string

Title of the note

content

string

Content of the note

Response

The contact's note has been created successfully

createdAt	string Creation date of the note
updatedAt	string Update date of the note
deletedAt	string Soft deletion date of the note
title	string Title of the note
content	string User written content of the note
contactId	string The contact owning the note
userId	string The user's who wrote the note
companyId	string The contact's company
groupId	string The user's group
deleted	boolean Does the contact's note has been removed

message	string
status	number
code	number

Suggest Edits

Filter contact notes

Filter contact notes with different search parameters

gethttps://api.datananas.com/contacts/contactId/notes

curl --request GET \
  --url https://api.datananas.com/contacts/contactId/notes

var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.datananas.com/contacts/contactId/notes' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts/contactId/notes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/contacts/contactId/notes");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts/contactId/notes"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

contactId

objectId

required

The id of the the contact owning the notes

Query Params

page

number

The number of the return page

limit

number

The maximum of return templates per page

filter

string

The string to match in the name, subject or message of the template

userId

objectId

The id of the the author of the note

Response

A list of notes that match

Suggest Edits

Delete a contact's note

deletehttps://api.datananas.com/contacts/contactId/notes/noteId

curl --request DELETE \
  --url https://api.datananas.com/contacts/contactId/notes/noteId

var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.datananas.com/contacts/contactId/notes/noteId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts/contactId/notes/noteId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.datananas.com/contacts/contactId/notes/noteId");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts/contactId/notes/noteId"

response = requests.request("DELETE", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

contactId

objectId

required

The contact's ID

noteId

objectId

required

The contact's note ID

Response

The note is deleted

message	string
status	number
code	number

message	string
status	number
code	number

Suggest Edits

get a contact's note

get an existing contact's note

gethttps://api.datananas.com/contacts/contactId/notes/noteId

curl --request GET \
  --url https://api.datananas.com/contacts/contactId/notes/noteId

var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.datananas.com/contacts/contactId/notes/noteId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts/contactId/notes/noteId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/contacts/contactId/notes/noteId");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts/contactId/notes/noteId"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

contactId

objectId

required

The id of the contact

noteId

objectId

required

The id of the note

Response

The contact's note content

createdAt	string Creation date of the note
updatedAt	string Update date of the note
deletedAt	string Soft deletion date of the note
title	string Title of the note
content	string User written content of the note
contactId	string The contact owning the note
userId	string The user's who wrote the note
companyId	string The contact's company
groupId	string The user's group
deleted	boolean Does the contact's note has been removed

message	string
status	number
code	number

Suggest Edits

Update a contact's note

Update an existing contact's note

patchhttps://api.datananas.com/contacts/contactId/notes/noteId

curl --request PATCH \
  --url https://api.datananas.com/contacts/contactId/notes/noteId

var request = require("request");

var options = { method: 'PATCH',
  url:
   'https://api.datananas.com/contacts/contactId/notes/noteId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/contacts/contactId/notes/noteId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.datananas.com/contacts/contactId/notes/noteId");

xhr.send(data);

import requests

url = "https://api.datananas.com/contacts/contactId/notes/noteId"

response = requests.request("PATCH", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

contactId

string

required

The id of the contact

noteId

string

required

The id of the note

Body Params

title

string

The new title of the note

content

string

The new content of the note

Response

The contact's note has been updated successfully

createdAt	string Creation date of the note
updatedAt	string Update date of the note
deletedAt	string Soft deletion date of the note
title	string Title of the note
content	string User written content of the note
contactId	string The contact owning the note
userId	string The user's who wrote the note
companyId	string The contact's company
groupId	string The user's group
deleted	boolean Does the contact's note has been removed

message	string
status	number
code	number

Suggest Edits

Sequences

Suggest Edits

Create sequence

Create a new sequence

posthttps://api.datananas.com/campaigns

curl --request POST \
  --url https://api.datananas.com/campaigns

var request = require("request");

var options = { method: 'POST', url: 'https://api.datananas.com/campaigns' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.datananas.com/campaigns");

xhr.send(data);

import requests

url = "https://api.datananas.com/campaigns"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Body Params

name

string

The name of the sequence

settings

object

This model is embedded inside Campaign and store the campaign settings

settings.isShared

boolean

Does the campaign settings are shared

settings.timeToSendEmail

number

Time at which mails will be sent

settings.emailsMaxPerDay

number

The maximum number of contacts added per day

settings.timezone

string

The timezone to use when sending emails

settings.trackOpens

boolean

Should we insert a pixel to track opening

settings.trackClicks

boolean

Should we track clicks on links

settings.removeWhenReply

boolean

Should we remove futur pending emails once replies

settings.allowInCampaignContacts

boolean

Allows to add contacts even if they are already in a campaign

settings.allowHasBeenInCampaignContacts

boolean

Allows to add contacts if they were in a campaign before

settings.unsubscribe

boolean

Should we insert an unsubscribe link

settings.weekDays

object

settings.weekDays.mo

boolean

Monday

settings.weekDays.tu

boolean

Tusday

settings.weekDays.we

boolean

Wednesday

settings.weekDays.th

boolean

Thursday

settings.weekDays.fr

boolean

Friday

settings.weekDays.sa

boolean

Saturday

settings.weekDays.su

boolean

Sunday

steps

array of objects

The different steps of the sequence

delay

timeToSendEmail

isRequired

type

content

Response

The sequence newly created

name	string The name of the campaign
deleted	boolean Does the campaign has been removed
deletedAt	boolean Date of the campaign deletion
steps	array The different steps of the campaign
settings	object This model is embedded inside Campaign and store the campaign settings
settings.isShared	boolean Does the campaign settings are shared
settings.timeToSendEmail	number Time at which mails will be sent
settings.emailsMaxPerDay	number The maximum number of contacts added per day
settings.timezone	string The timezone to use when sending emails
settings.trackOpens	boolean Should we insert a pixel to track opening
settings.trackClicks	boolean Should we track clicks on links
settings.removeWhenReply	boolean Should we remove futur pending emails once replies
settings.allowInCampaignContacts	boolean Allows to add contacts even if they are already in a campaign
settings.allowHasBeenInCampaignContacts	boolean Allows to add contacts if they were in a campaign before
settings.unsubscribe	boolean Should we insert an unsubscribe link
settings.weekDays	object
settings.weekDays.mo	boolean Monday
settings.weekDays.tu	boolean Tusday
settings.weekDays.we	boolean Wednesday
settings.weekDays.th	boolean Thursday
settings.weekDays.fr	boolean Friday
settings.weekDays.sa	boolean Saturday
settings.weekDays.su	boolean Sunday
userId	string The id of the user (ObjectId)
campaignId	string The id of the campaign (ObjectId)
groupId	string The group (ObjectId)
date_created	string The date at which the campaign has been created
updatedAt	string last update date

Suggest Edits

Find sequences

Search sequences

gethttps://api.datananas.com/campaigns

curl --request GET \
  --url https://api.datananas.com/campaigns

var request = require("request");

var options = { method: 'GET', url: 'https://api.datananas.com/campaigns' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/campaigns");

xhr.send(data);

import requests

url = "https://api.datananas.com/campaigns"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

filter

string

filter to apply on the list of sequences

id

objectId

Filter sequences by id

page

number

The number of the return page

limit

number

The maximum of return sequences per page

Response

The list of sequences

message	string
status	number
code	number

Suggest Edits

Delete sequence

Delete a sequence

deletehttps://api.datananas.com/campaigns/id

curl --request DELETE \
  --url https://api.datananas.com/campaigns/id

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.datananas.com/campaigns/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/campaigns/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.datananas.com/campaigns/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/campaigns/id"

response = requests.request("DELETE", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The sequence's ID

Response

The sequence has been deleted successfully

affected	object
affected.emails	number Removed pending emails count
affected.contacts	number Contacts which were in the sequence before deletion

message	string
status	number
code	number

message	string
status	number
code	number

Suggest Edits

Get sequence

Get a single sequence by id

gethttps://api.datananas.com/campaigns/id

curl --request GET \
  --url https://api.datananas.com/campaigns/id

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.datananas.com/campaigns/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/campaigns/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/campaigns/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/campaigns/id"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

objectId

required

The sequence id

Response

A sequence

name	string The name of the campaign
deleted	boolean Does the campaign has been removed
deletedAt	boolean Date of the campaign deletion
steps	array The different steps of the campaign
settings	object This model is embedded inside Campaign and store the campaign settings
settings.isShared	boolean Does the campaign settings are shared
settings.timeToSendEmail	number Time at which mails will be sent
settings.emailsMaxPerDay	number The maximum number of contacts added per day
settings.timezone	string The timezone to use when sending emails
settings.trackOpens	boolean Should we insert a pixel to track opening
settings.trackClicks	boolean Should we track clicks on links
settings.removeWhenReply	boolean Should we remove futur pending emails once replies
settings.allowInCampaignContacts	boolean Allows to add contacts even if they are already in a campaign
settings.allowHasBeenInCampaignContacts	boolean Allows to add contacts if they were in a campaign before
settings.unsubscribe	boolean Should we insert an unsubscribe link
settings.weekDays	object
settings.weekDays.mo	boolean Monday
settings.weekDays.tu	boolean Tusday
settings.weekDays.we	boolean Wednesday
settings.weekDays.th	boolean Thursday
settings.weekDays.fr	boolean Friday
settings.weekDays.sa	boolean Saturday
settings.weekDays.su	boolean Sunday
userId	string The id of the user (ObjectId)
campaignId	string The id of the campaign (ObjectId)
groupId	string The group (ObjectId)
date_created	string The date at which the campaign has been created
updatedAt	string last update date

message	string
status	number
code	number

Suggest Edits

Update sequence

Update an existing sequence

patchhttps://api.datananas.com/campaigns/id

curl --request PATCH \
  --url https://api.datananas.com/campaigns/id

var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.datananas.com/campaigns/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/campaigns/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.datananas.com/campaigns/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/campaigns/id"

response = requests.request("PATCH", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The id of the sequence

Body Params

name

string

The name of the sequence

settings

object

This model is embedded inside Campaign and store the campaign settings

settings.isShared

boolean

Does the campaign settings are shared

settings.timeToSendEmail

number

Time at which mails will be sent

settings.emailsMaxPerDay

number

The maximum number of contacts added per day

settings.timezone

string

The timezone to use when sending emails

settings.trackOpens

boolean

Should we insert a pixel to track opening

settings.trackClicks

boolean

Should we track clicks on links

settings.removeWhenReply

boolean

Should we remove futur pending emails once replies

settings.allowInCampaignContacts

boolean

Allows to add contacts even if they are already in a campaign

settings.allowHasBeenInCampaignContacts

boolean

Allows to add contacts if they were in a campaign before

settings.unsubscribe

boolean

Should we insert an unsubscribe link

settings.weekDays

object

settings.weekDays.mo

boolean

Monday

settings.weekDays.tu

boolean

Tusday

settings.weekDays.we

boolean

Wednesday

settings.weekDays.th

boolean

Thursday

settings.weekDays.fr

boolean

Friday

settings.weekDays.sa

boolean

Saturday

settings.weekDays.su

boolean

Sunday

steps

array of objects

The different steps of the sequence

delay

timeToSendEmail

isRequired

type

content

Response

The sequence has been updated successfully

name	string The name of the campaign
deleted	boolean Does the campaign has been removed
deletedAt	boolean Date of the campaign deletion
steps	array The different steps of the campaign
settings	object This model is embedded inside Campaign and store the campaign settings
settings.isShared	boolean Does the campaign settings are shared
settings.timeToSendEmail	number Time at which mails will be sent
settings.emailsMaxPerDay	number The maximum number of contacts added per day
settings.timezone	string The timezone to use when sending emails
settings.trackOpens	boolean Should we insert a pixel to track opening
settings.trackClicks	boolean Should we track clicks on links
settings.removeWhenReply	boolean Should we remove futur pending emails once replies
settings.allowInCampaignContacts	boolean Allows to add contacts even if they are already in a campaign
settings.allowHasBeenInCampaignContacts	boolean Allows to add contacts if they were in a campaign before
settings.unsubscribe	boolean Should we insert an unsubscribe link
settings.weekDays	object
settings.weekDays.mo	boolean Monday
settings.weekDays.tu	boolean Tusday
settings.weekDays.we	boolean Wednesday
settings.weekDays.th	boolean Thursday
settings.weekDays.fr	boolean Friday
settings.weekDays.sa	boolean Saturday
settings.weekDays.su	boolean Sunday
userId	string The id of the user (ObjectId)
campaignId	string The id of the campaign (ObjectId)
groupId	string The group (ObjectId)
date_created	string The date at which the campaign has been created
updatedAt	string last update date

message	string
status	number
code	number

message	string
status	number
code	number

Suggest Edits

Get sequence reports

Get sequence reports for a sequence

gethttps://api.datananas.com/campaigns/id/reports

curl --request GET \
  --url https://api.datananas.com/campaigns/id/reports

var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.datananas.com/campaigns/id/reports' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/campaigns/id/reports")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/campaigns/id/reports");

xhr.send(data);

import requests

url = "https://api.datananas.com/campaigns/id/reports"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

objectId

required

The sequence id

Query Params

page

integer

Page to retrieve

limit

integer

Number of results per page (limited to 50)

Response

sequence reports

message	string
status	number
code	number

Suggest Edits

Get stats

Get stats for a sequence

gethttps://api.datananas.com/campaigns/id/stats

curl --request GET \
  --url https://api.datananas.com/campaigns/id/stats

var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.datananas.com/campaigns/id/stats' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/campaigns/id/stats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/campaigns/id/stats");

xhr.send(data);

import requests

url = "https://api.datananas.com/campaigns/id/stats"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

objectId

required

The sequence id

Response

Campaign stats

name	string The name of the campaign
deleted	boolean Does the campaign has been removed
deletedAt	boolean Date of the campaign deletion
steps	array The different steps of the campaign
settings	object This model is embedded inside Campaign and store the campaign settings
settings.isShared	boolean Does the campaign settings are shared
settings.timeToSendEmail	number Time at which mails will be sent
settings.emailsMaxPerDay	number The maximum number of contacts added per day
settings.timezone	string The timezone to use when sending emails
settings.trackOpens	boolean Should we insert a pixel to track opening
settings.trackClicks	boolean Should we track clicks on links
settings.removeWhenReply	boolean Should we remove futur pending emails once replies
settings.allowInCampaignContacts	boolean Allows to add contacts even if they are already in a campaign
settings.allowHasBeenInCampaignContacts	boolean Allows to add contacts if they were in a campaign before
settings.unsubscribe	boolean Should we insert an unsubscribe link
settings.weekDays	object
settings.weekDays.mo	boolean Monday
settings.weekDays.tu	boolean Tusday
settings.weekDays.we	boolean Wednesday
settings.weekDays.th	boolean Thursday
settings.weekDays.fr	boolean Friday
settings.weekDays.sa	boolean Saturday
settings.weekDays.su	boolean Sunday
userId	string The id of the user (ObjectId)
campaignId	string The id of the campaign (ObjectId)
groupId	string The group (ObjectId)
date_created	string The date at which the campaign has been created
updatedAt	string last update date

message	string
status	number
code	number

Suggest Edits

Unsubscribe from all sequences

Unsubscribe multiple contacts from all sequences

deletehttps://api.datananas.com/campaigns/contacts

curl --request DELETE \
  --url 'https://api.datananas.com/campaigns/contacts?contactIds=contactIds'

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.datananas.com/campaigns/contacts',
  qs: { contactIds: 'contactIds' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/campaigns/contacts?contactIds=contactIds")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.datananas.com/campaigns/contacts?contactIds=contactIds");

xhr.send(data);

import requests

url = "https://api.datananas.com/campaigns/contacts"

querystring = {"contactIds":"contactIds"}

response = requests.request("DELETE", url, params=querystring)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

contactIds

array of strings

required

The ids of the contacts to unsubscribe

hard

boolean

True if contacts must be marked as unsubscribed

filter

string

Filter by keyword

listId

objectId

Filter contacts by list. Should be a listId or list of listId

userId

objectId

Filter contacts by owner. Should be a userId or list of userId

companySize

string

Filter contacts by company size

companyIndustry

string

Filter contacts by company industry

city

string

Filter contacts by city

country

string

Filter contacts by country

role

string

Filter contacts by role

status

string

Filter contacts by status

dateAdded

array of strings

Filter contacts by added ISO8601 date. Takes an array of two items were the first index is dateStart and the second is dateEnd.

campaignId

objectId

Filter contacts by campaign. Can be a single campaignId or multiple campaignId

isActiveInCampaign

boolean

Filter contacts by campaign activity

email

string

Filter contacts by email

lastEmailCategory

string

Filter contacts by last email category

Response

Some or all contacts have been unsubscribed successfully

success	boolean Has the contacts been unsubscribed

Suggest Edits

Companies

Suggest Edits

Companies introduction

Companies are related to users and not contacts

Suggest Edits

Get a company

Get a company by id. A company contains groups that contain users.

gethttps://api.datananas.com/companies/id

curl --request GET \
  --url https://api.datananas.com/companies/id

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.datananas.com/companies/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/companies/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/companies/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/companies/id"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The company id

Response

A company

company_name	string The name of the enterprise
outboundPlan	string The plan of the selected by the customer
quotas	object Company quotas
period	number Period of subscription in months
crm_bcc_email	string Recipient to add to the BCC when replying
phone	string The phone number
credits	number The number of credits of the customer
nbLicences	number The number of licences of the customer
excluded_emails	array The list of email addresses excluded
address	object Infos about GDPR related contacts
address.address_1	string The first line of an address
address.address_2	string The second line of an address
address.postal_code	string The zip code
address.city	string The city name
address.country	string The country name
address.phone_number	string The phone number
address.is_headquarter	boolean Is this address the headquarter
infos	object Infos about GDPR related contacts
infos.data_collector	object Person responsible for data collection in the company
infos.data_collector.first_name	string First name of the person responsible for data collection
infos.data_collector.last_name	string Last name of the person responsible for data collection
infos.data_collector.email	string Email of the person responsible for data collection
infos.data_collector.role	string Role of the person responsible for data collection
infos.dpo	object Person who is Data Protection Officer
infos.dpo.first_name	string First name of the DPO
infos.dpo.last_name	string Last name of the DPO
infos.dpo.email	string Email of the DPO
infos.dpo.role	string Role of the DPO
vat	string The value added tax identification number
settings	object Main settings for the customer
settings.campaign_reply_webhook_url	string An URL on which to send webhook when a contact replies to a campaign
settings.twilio	object
settings.twilio.account_sid	string Twillio subaccount Id
settings.twilio.auth_token	string Twillio auth token
settings.gdpr	object
settings.gdpr.isArchiving	boolean Should contacts be deleted after a certain delay
settings.gdpr.archiveDelay	number Number of days to wait from the collectedAt date to archive
settings.gdpr.archiveStatus	array List of contact status to archive after delay is passed
deleted	boolean Is the company deleted
deletedAt	string When the company has been deleted
createdAt	string date of creation
updatedAt	string last update date

Suggest Edits

Update company

Update a company

patchhttps://api.datananas.com/companies/id

curl --request PATCH \
  --url https://api.datananas.com/companies/id

var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.datananas.com/companies/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/companies/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.datananas.com/companies/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/companies/id"

response = requests.request("PATCH", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The company's ID

Body Params

company_name

string

The name of the company

outboundPlan

string

The plan of the company (null, trial, standard, profesionnal)

nbLicences

number

Number of licences in the company

address

object

Infos about GDPR related contacts

address.address_1

string

The first line of an address

address.address_2

string

The second line of an address

address.postal_code

string

The zip code

address.city

string

The city name

address.country

string

The country name

address.phone_number

string

The phone number

address.is_headquarter

boolean

Is this address the headquarter

infos

object

Infos about GDPR related contacts

infos.data_collector

object

Person responsible for data collection in the company

infos.data_collector.first_name

string

First name of the person responsible for data collection

infos.data_collector.last_name

string

Last name of the person responsible for data collection

infos.data_collector.email

string

Email of the person responsible for data collection

infos.data_collector.role

string

Role of the person responsible for data collection

infos.dpo

object

Person who is Data Protection Officer

infos.dpo.first_name

string

First name of the DPO

infos.dpo.last_name

string

Last name of the DPO

infos.dpo.email

string

Email of the DPO

infos.dpo.role

string

Role of the DPO

settings

object

Main settings for the customer

settings.gdpr

object

settings.gdpr.isArchiving

boolean

Should contacts be deleted after a certain delay

settings.gdpr.archiveDelay

number

Number of days to wait from the collectedAt date to archive

settings.gdpr.archiveStatus

array

List of contact status to archive after delay is passed

Response

The company updated

company_name	string The name of the enterprise
outboundPlan	string The plan of the selected by the customer
quotas	object Company quotas
period	number Period of subscription in months
crm_bcc_email	string Recipient to add to the BCC when replying
phone	string The phone number
credits	number The number of credits of the customer
nbLicences	number The number of licences of the customer
excluded_emails	array The list of email addresses excluded
address	object Infos about GDPR related contacts
address.address_1	string The first line of an address
address.address_2	string The second line of an address
address.postal_code	string The zip code
address.city	string The city name
address.country	string The country name
address.phone_number	string The phone number
address.is_headquarter	boolean Is this address the headquarter
infos	object Infos about GDPR related contacts
infos.data_collector	object Person responsible for data collection in the company
infos.data_collector.first_name	string First name of the person responsible for data collection
infos.data_collector.last_name	string Last name of the person responsible for data collection
infos.data_collector.email	string Email of the person responsible for data collection
infos.data_collector.role	string Role of the person responsible for data collection
infos.dpo	object Person who is Data Protection Officer
infos.dpo.first_name	string First name of the DPO
infos.dpo.last_name	string Last name of the DPO
infos.dpo.email	string Email of the DPO
infos.dpo.role	string Role of the DPO
vat	string The value added tax identification number
settings	object Main settings for the customer
settings.campaign_reply_webhook_url	string An URL on which to send webhook when a contact replies to a campaign
settings.twilio	object
settings.twilio.account_sid	string Twillio subaccount Id
settings.twilio.auth_token	string Twillio auth token
settings.gdpr	object
settings.gdpr.isArchiving	boolean Should contacts be deleted after a certain delay
settings.gdpr.archiveDelay	number Number of days to wait from the collectedAt date to archive
settings.gdpr.archiveStatus	array List of contact status to archive after delay is passed
deleted	boolean Is the company deleted
deletedAt	string When the company has been deleted
createdAt	string date of creation
updatedAt	string last update date

Suggest Edits

Find companies

List companies

gethttps://api.datananas.com/companies/

curl --request GET \
  --url https://api.datananas.com/companies/

var request = require("request");

var options = { method: 'GET', url: 'https://api.datananas.com/companies/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/companies/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/companies/");

xhr.send(data);

import requests

url = "https://api.datananas.com/companies/"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Response

A list of company

Suggest Edits

Get quotas for a company

Gives quotas and actual consumption for each quota

gethttps://api.datananas.com/companies/id/quotas

curl --request GET \
  --url https://api.datananas.com/companies/id/quotas

var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.datananas.com/companies/id/quotas' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/companies/id/quotas")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/companies/id/quotas");

xhr.send(data);

import requests

url = "https://api.datananas.com/companies/id/quotas"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The company's ID

Response

Company's quotas

contact_create	array first index => quota, second index => actual consumption
items	integer

Suggest Edits

Get stats for a company

Gives statistics for the company for a given period.
For each user it shows the number of emails sent, reply rate, and number of replies by category
Categories are positive, negative, out of office, wrong contact, bounce

gethttps://api.datananas.com/companies/id/stats

curl --request GET \
  --url https://api.datananas.com/companies/id/stats

var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.datananas.com/companies/id/stats' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/companies/id/stats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/companies/id/stats");

xhr.send(data);

import requests

url = "https://api.datananas.com/companies/id/stats"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The company's ID

Response

Stats for the requested period of the company

Suggest Edits

List groups

List all groups in a company

gethttps://api.datananas.com/companies/:companyId/groups

curl --request GET \
  --url https://api.datananas.com/companies/:companyId/groups

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.datananas.com/companies/:companyId/groups' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/companies/:companyId/groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/companies/:companyId/groups");

xhr.send(data);

import requests

url = "https://api.datananas.com/companies/:companyId/groups"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Response

A list of group

Suggest Edits

List integrations

List all integrations for a given company

gethttps://api.datananas.com/companies/companyId/integrations

curl --request GET \
  --url https://api.datananas.com/companies/companyId/integrations

var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.datananas.com/companies/companyId/integrations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/companies/companyId/integrations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/companies/companyId/integrations");

xhr.send(data);

import requests

url = "https://api.datananas.com/companies/companyId/integrations"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

companyId

objectId

required

The id of the company

Response

A list of integrations

Suggest Edits

Export

Suggest Edits

Export resources

Exports the entire account's contacts or blacklist

gethttps://api.datananas.com/export/resource

curl --request GET \
  --url https://api.datananas.com/export/resource

var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.datananas.com/export/resource' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/export/resource")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/export/resource");

xhr.send(data);

import requests

url = "https://api.datananas.com/export/resource"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

resource

string

required

resource to export

Query Params

searchId

string

An id of a saved search

Response

The file has been created and will be uploaded

Suggest Edits

Integrations

Suggest Edits

Create an integration

posthttps://api.datananas.com/integrations

curl --request POST \
  --url https://api.datananas.com/integrations

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.datananas.com/integrations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/integrations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.datananas.com/integrations");

xhr.send(data);

import requests

url = "https://api.datananas.com/integrations"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Body Params

userId

objectId

Id of the user

roles

array

List of roles accessible to the integration

Response

Integration created

Suggest Edits

Delete integration

Delete and revoke an integration

deletehttps://api.datananas.com/integrations/id

curl --request DELETE \
  --url https://api.datananas.com/integrations/id

var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.datananas.com/integrations/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/integrations/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.datananas.com/integrations/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/integrations/id"

response = requests.request("DELETE", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The integration's ID

Response

Integration deleted and revoked

Suggest Edits

Authorize provider (Oauth2)

Initialize an OAuth 2 connection with an external provider

gethttps://api.datananas.com/oauth2/provider/authorize

curl --request GET \
  --url https://api.datananas.com/oauth2/provider/authorize

var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.datananas.com/oauth2/provider/authorize' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/oauth2/provider/authorize")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/oauth2/provider/authorize");

xhr.send(data);

import requests

url = "https://api.datananas.com/oauth2/provider/authorize"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

provider

string

required

The name of the provider to authorize

Query Params

redirectUrl

string

An optional URL on which to redirect after connection is complete

email

string

An optional email to connect the account

Response

Provider connection needed

Suggest Edits

Provider callback

Finalize an OAuth 2 connection with an external provider

gethttps://api.datananas.com/oauth2/provider/callback

curl --request GET \
  --url 'https://api.datananas.com/oauth2/provider/callback?code=code&state=state'

var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.datananas.com/oauth2/provider/callback',
  qs:
   { code: 'code',
     state: 'state' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/oauth2/provider/callback?code=code&state=state")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/oauth2/provider/callback?code=code&state=state");

xhr.send(data);

import requests

url = "https://api.datananas.com/oauth2/provider/callback"

querystring = {"code":"code","state":"state"}

response = requests.request("GET", url, params=querystring)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

provider

string

required

The provider

Query Params

code

string

required

The OAuth2 code to exchange with the provider

state

string

required

This is an Uri encoded json containing userId (required) and a redirectUrl (optional)

Response

Connection finished or failed (redirect)

Suggest Edits

Revoke provider

Disconnect an OAuth2 account

deletehttps://api.datananas.com/oauth2/provider/revoke/id?

curl --request DELETE \
  --url https://api.datananas.com/oauth2/provider/revoke/id

var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.datananas.com/oauth2/provider/revoke/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/oauth2/provider/revoke/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.datananas.com/oauth2/provider/revoke/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/oauth2/provider/revoke/id"

response = requests.request("DELETE", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

provider

string

required

The provider to revoke

id

string

required

An optional user ID to disconnect

Response

Provider disconnected successfully

Suggest Edits

Invoices

Suggest Edits

Find invoices

Get invoices according to filters like the price or the company

gethttps://api.datananas.com/invoices/

curl --request GET \
  --url https://api.datananas.com/invoices/

var request = require("request");

var options = { method: 'GET', url: 'https://api.datananas.com/invoices/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/invoices/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/invoices/");

xhr.send(data);

import requests

url = "https://api.datananas.com/invoices/"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

customerId

string

Company id

total

number

Total amount paid by the company

plan

string

outbound plan

Response

Selected invoices

Suggest Edits

Get an invoice

Get an invoice by id

gethttps://api.datananas.com/invoices/id

curl --request GET \
  --url https://api.datananas.com/invoices/id

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.datananas.com/invoices/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/invoices/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/invoices/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/invoices/id"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

Invoice id

Response

An Invoice

id_number	number Invoice number
amount	number Total amount of invoice tax excluded
vat	number VAT percentage
amount_vat	number VAT amount
total	number Total amount of invoice tax included
currency	string Currency of the invoice (€ or $)
lines	array Lines in the invoice per different item type
userId	string The owner id of this contact (ObjectId)
customerId	string The id of the company (ObjectId)
plan	string Plan of subscription
description	string An optional description
stripeid	number Stripe Id of the invoice
owner	string name of the sales owner
sdrowner	string name of the sdr owner
csmowner	string name of the csm owner

Suggest Edits

Lists

Suggest Edits

Create list

Create a new list of contacts

posthttps://api.datananas.com/lists

curl --request POST \
  --url https://api.datananas.com/lists

var request = require("request");

var options = { method: 'POST', url: 'https://api.datananas.com/lists' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/lists")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.datananas.com/lists");

xhr.send(data);

import requests

url = "https://api.datananas.com/lists"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Body Params

list_name

string

The name of the list

Response

The list newly created

list_name	string The name of the list
userId	string The owner of the list (ObjectId)
companyId	string The company of the owner (ObjectId)
isShared	boolean Does the list is shared
groupId	string The id of the group (ObjectId)
createdAt	string date of creation
updatedAt	string last update date
deleted	boolean Does the list has been removed
deletedAt	string Date of the list deletion

Suggest Edits

Filter lists

Filter lists of contacts

gethttps://api.datananas.com/lists

curl --request GET \
  --url https://api.datananas.com/lists

var request = require("request");

var options = { method: 'GET', url: 'https://api.datananas.com/lists' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/lists")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/lists");

xhr.send(data);

import requests

url = "https://api.datananas.com/lists"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

filter

string

Search lists by name

page

string

The number of the page to return

limit

number

The maximum of return lists per page

Response

The list of lists

Suggest Edits

Delete list

Delete a list

deletehttps://api.datananas.com/lists/id

curl --request DELETE \
  --url https://api.datananas.com/lists/id

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.datananas.com/lists/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/lists/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.datananas.com/lists/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/lists/id"

response = requests.request("DELETE", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The list's ID

Response

The list deleted

nbAffectedContacts	number Number of affected contacts (softly deleted)

Suggest Edits

Update list

Edit a list of contacts

patchhttps://api.datananas.com/lists/id

curl --request PATCH \
  --url https://api.datananas.com/lists/id

var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.datananas.com/lists/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/lists/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.datananas.com/lists/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/lists/id"

response = requests.request("PATCH", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The id of the lust

Body Params

list_name

string

The new name of the list

userId

string

The new owner of the list

groupId

string

The new group of the list

Response

The list edited

list_name	string The name of the list
userId	string The owner of the list (ObjectId)
companyId	string The company of the owner (ObjectId)
isShared	boolean Does the list is shared
groupId	string The id of the group (ObjectId)
createdAt	string date of creation
updatedAt	string last update date
deleted	boolean Does the list has been removed
deletedAt	string Date of the list deletion

Suggest Edits

Messages

Suggest Edits

Create a message

Create a new message

posthttps://api.datananas.com/messages

curl --request POST \
  --url https://api.datananas.com/messages

var request = require("request");

var options = { method: 'POST', url: 'https://api.datananas.com/messages' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.datananas.com/messages");

xhr.send(data);

import requests

url = "https://api.datananas.com/messages"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Body Params

to

object

to.contacts

array of strings

required

to.users

array of strings

cc

object

cc.contacts

array of strings

cc.users

array of strings

bcc

object

bcc.contacts

array of strings

bcc.users

array of strings

subject

string

required

Subject of the message

body

string

required

HTML body of the message

replyToMessageId

string

Id (not NylasMessageID) of the message which this message is a response to

Response

The message has been created successfully

cursor	string The mailbox cursor at which the message has been synced
category	string The category of the message
syncDate	string Date at which we synchronized the mailbox
date	string Reception date of the email
replyDate	string Date at which the email has been replied
body	string The content of the message (can contains HTML)
subject	string The subject of the email
snippet	string A shorten version of the body (only text)
events	array An array of events linked in the email
files	array An array of files attached to the email
labels	array An array of folders in which the message is
starred	boolean Does the message has been starred by the mailbox owner
unread	boolean Does the message has been read
headers	object
headers.Message-Id	string The real message id of the IMAP headers
headers.References	array The list of message id of the current discussion
headers.In-Reply-To	string The message id this message is replying to
nylasMessageId	string The id of the message returned by the nylas api
nylasThreadId	string The id of the thread returned by the nylas api
nylasAccountId	string The nylas account id of the user
campaignId	string The id of the campaign, assigned once reconciled (ObjectId)
userId	string The id of the user (ObjectId)
supervisorId	string The eventual ID of the campaign supervisor for the contact (ObjectId)
contactId	string The sender id, assigned once reconciled (ObjectId)
from	object Information about an recipient, sender
from.email	string An email address
from.name	string A first name and a last_name
to	object Information about an recipient, sender
to.email	string An email address
to.name	string A first name and a last_name
cc	object Information about an recipient, sender
cc.email	string An email address
cc.name	string A first name and a last_name
bcc	object Information about an recipient, sender
bcc.email	string An email address
bcc.name	string A first name and a last_name
groupId	string The id of the group (ObjectId)
timezone	string The timezone to use when sending emails
createdAt	string date of creation
updatedAt	string last update date
extractedData	object Data extracted by the email classification post processing
language	string Message language http://www.lingoes.net/en/translator/langcode.htm
actions	array

Suggest Edits

Filter messages

Filter all messages belonging to the user or his group

gethttps://api.datananas.com/messages

curl --request GET \
  --url https://api.datananas.com/messages

var request = require("request");

var options = { method: 'GET', url: 'https://api.datananas.com/messages' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/messages");

xhr.send(data);

import requests

url = "https://api.datananas.com/messages"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

category

string

Search messages by category

userId

string

Search messages by userId

campaignId

string

Search messages by campaignId

listId

string

Search messages by listId

contactId

string

Search messages by contactId

done

boolean

Search messages by done

page

string

The number of the page to return

limit

number

The maximum of return lists per page

Response

A list of messages

Suggest Edits

Get a message

Get a message by id

gethttps://api.datananas.com/messages/id

curl --request GET \
  --url https://api.datananas.com/messages/id

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.datananas.com/messages/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/messages/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/messages/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/messages/id"

response = requests.request("GET", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The message id

Response

A message

Suggest Edits

Update message

patchhttps://api.datananas.com/messages/id

curl --request PATCH \
  --url https://api.datananas.com/messages/id

var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.datananas.com/messages/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/messages/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.datananas.com/messages/id");

xhr.send(data);

import requests

url = "https://api.datananas.com/messages/id"

response = requests.request("PATCH", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

id

string

required

The id of the message

Body Params

starred

boolean

The message star status

done

boolean

True if the message has been processed by the user

unread

boolean

The message read status (true if message is not read)

actions

object

actions._id

objectId

required

Id of the smart action to update

actions.status

string

required

New status of the smart action

Response

The message has been updated successfully

cursor	string The mailbox cursor at which the message has been synced
category	string The category of the message
syncDate	string Date at which we synchronized the mailbox
date	string Reception date of the email
replyDate	string Date at which the email has been replied
body	string The content of the message (can contains HTML)
subject	string The subject of the email
snippet	string A shorten version of the body (only text)
events	array An array of events linked in the email
files	array An array of files attached to the email
labels	array An array of folders in which the message is
starred	boolean Does the message has been starred by the mailbox owner
unread	boolean Does the message has been read
headers	object
headers.Message-Id	string The real message id of the IMAP headers
headers.References	array The list of message id of the current discussion
headers.In-Reply-To	string The message id this message is replying to
nylasMessageId	string The id of the message returned by the nylas api
nylasThreadId	string The id of the thread returned by the nylas api
nylasAccountId	string The nylas account id of the user
campaignId	string The id of the campaign, assigned once reconciled (ObjectId)
userId	string The id of the user (ObjectId)
supervisorId	string The eventual ID of the campaign supervisor for the contact (ObjectId)
contactId	string The sender id, assigned once reconciled (ObjectId)
from	object Information about an recipient, sender
from.email	string An email address
from.name	string A first name and a last_name
to	object Information about an recipient, sender
to.email	string An email address
to.name	string A first name and a last_name
cc	object Information about an recipient, sender
cc.email	string An email address
cc.name	string A first name and a last_name
bcc	object Information about an recipient, sender
bcc.email	string An email address
bcc.name	string A first name and a last_name
groupId	string The id of the group (ObjectId)
timezone	string The timezone to use when sending emails
createdAt	string date of creation
updatedAt	string last update date
extractedData	object Data extracted by the email classification post processing
language	string Message language http://www.lingoes.net/en/translator/langcode.htm
actions	array

Suggest Edits

Get messages values

Get messages list of values

gethttps://api.datananas.com/messages/values

curl --request GET \
  --url 'https://api.datananas.com/messages/values?field=field'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.datananas.com/messages/values',
  qs: { field: 'field' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/messages/values?field=field")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.datananas.com/messages/values?field=field");

xhr.send(data);

import requests

url = "https://api.datananas.com/messages/values"

querystring = {"field":"field"}

response = requests.request("GET", url, params=querystring)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Query Params

field

string

required

Field values to fetch. Must be a field from GET /messages endpoint

filter

string

Filter results by name. Filter is case-insensitive

page

integer

Page to retrieve

limit

integer

Number of results per page (limited to 50)

Response

A list of values that match

Suggest Edits

Email Rating

Scores an email subject and body to help your improve it

posthttps://api.datananas.com/rate-email

curl --request POST \
  --url https://api.datananas.com/rate-email

var request = require("request");

var options = { method: 'POST', url: 'https://api.datananas.com/rate-email' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/rate-email")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.datananas.com/rate-email");

xhr.send(data);

import requests

url = "https://api.datananas.com/rate-email"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Body Params

subject

string

An email's subject

body

string

An email's body

Response

OK, Email scored without any issue

subjectMark	number The global score of the email's subject, this is the result of a weighted average of the numbers in `scores`, according weights are not shown
bodyMark	number The global score of the email's body, this is the result of a weighted average of the numbers in `scores`, according weights are not shown
scores	array Scores are grouped by similarities. This array contains these grouped scores
subject	object Contains email's subject scores
subject.length	number Score based on the number of words in a subject
subject.variablesNumber	number Score based on the number of variables in a subject
subject.variablesUsage	number Score based on the usage of the variables in a subject, their usage in a context and their name
subject.spamness	number Score based on the number of spam keywords in a subject
body	object Contains email's body scores
body.callToAction	number A score based on the number of callToAction tokens ('?' character)
body.dates	number Score based on the number of date tokens (uses a NER system)
body.introBlock	number Score based on the count of greeting words and variables (do the variables contain `name` in it ? such as
body.length	number Score based on the number of words in a body
body.lines	number Score based on the number of lines in a body
body.opinion	number Score based on the subjectivity and objectivity of terms in a body
body.outroBlock	number Score based on the thanks formulation used
body.paragraphCount	number Score based on the number of paragraphs in a body
body.pointOfView	number Score that express a balance of use between personnal pronouns
body.sentencesLength	number Score based on the mean number of characters of sentences in a body
body.sentencesNumber	number A score based on the number of sentences in a body
body.sentencesWords	number Score based on the mean number of words of sentences in a body
body.sentiment	number Score based on the positivity and negativity of the terms used in a body
body.signature	number Score based on the named entities used in your signature (does it have a first/last name combo, reach contact informations)
body.spamness	number Score based on the number of spam tokens used in a body
body.structure	number Score based on how well you fit to the e-mail structure we promote at Datananas (greeting, hook, issue, value, call to action, greeting, signature)
body.variablesNumber	number Score based on the number of variables in a body
body.variablesUsage	number Score based on the usage of the variables in a subject, their usage in a context and their name
body.vocabLevel	number Score based on the vocabulary level of the body, (should be first-grade, middle school, high school, academic or technical levels)
feedbacks	object
feedbacks.negatives	array negatives feedbacks for when a group of variable isn't well scored
feedbacks.positives	object positives feedbacks for when a group of variable is well scored

Suggest Edits

Provider

Suggest Edits

Authorize provider

Connect to an extenal provider with a simple request

posthttps://api.datananas.com/oauth2/provider/authorize

curl --request POST \
  --url https://api.datananas.com/oauth2/provider/authorize

var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.datananas.com/oauth2/provider/authorize' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.datananas.com/oauth2/provider/authorize")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.datananas.com/oauth2/provider/authorize");

xhr.send(data);

import requests

url = "https://api.datananas.com/oauth2/provider/authorize"

response = requests.request("POST", url)

print(response.text)

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

A binary file was returned

Your OAuth2 token is incorrect or has expired

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

Try the API to see results

Path Params

provider

string

required

The name of the provider to authorize

Body Params

name

string

The format of the body and parameters depend on the provider

API Status

Getting started

Use it for your own account

Connect your application with Datananas

Authentication

Access Level

How to authenticate

Generic Errors

OAuth2 Auth

Query Params

200Response

OAuth2 Auth

Query Params

200Response

OAuth2 Auth

Query Params

200Response

OAuth2 Auth

Body Params

201Response

OAuth2 Auth

Body Params

201Response

OAuth2 Auth

Query Params

200Response

OAuth2 Auth

Path Params

202403404Response

OAuth2 Auth

200403Response

Body Params

200Response

OAuth2 Auth

Query Params

Body Params

200402403404Response

OAuth2 Auth

Path Params

200403404Response

OAuth2 Auth

Body Params

200403409Response

OAuth2 Auth

Query Params

200Response

OAuth2 Auth

Query Params

202403404Response

OAuth2 Auth

Query Params

Body Params

200404Response

OAuth2 Auth

Path Params

202403404Response

OAuth2 Auth

Path Params

200Response

OAuth2 Auth

Path Params

Body Params

200404409Response

OAuth2 Auth

Query Params

200Response

OAuth2 Auth

200Response

OAuth2 Auth

Query Params

200Response

OAuth2 Auth

Path Params

Query Params

200Response

OAuth2 Auth

Query Params

Body Params

200Response

OAuth2 Auth

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response