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 [email protected] 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 [email protected] and get your client_id and client_secret

Authentication

Please get in touch with our team to get an access token using [email protected]

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 or cannot be found

409

Conflict

There is a conflict and you request can't be processed. For example, this can happen if you try to rename a sequence with a name which is already taken by another sequence.

422

Unprocessable Entity

This errors occurs when the request cannot be processed even tough its format is valid (contrary to Bad Request)

424

Failed Dependency

When updating a resource requires access to another resource, and this second resource has an error.

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 [email protected]

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

Update card

Update credit card information

patchhttps://api.datananas.com/billing/card

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

var request = require("request");

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

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/card")

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/billing/card");

xhr.send(data);

import requests

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

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

Body Params

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

Response

The credit card has been updated

Suggest Edits

Get discount

Returns a discount coupon if exists

gethttps://api.datananas.com/billing/discount

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

var request = require("request");

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

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/discount")

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/billing/discount");

xhr.send(data);

import requests

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

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

code

string

Coupon code

Response

Discount

Suggest Edits

Subscribe confirm

Confirm a subscription intent after Strong Customer Authentication

gethttps://api.datananas.com/billing/subscribe/confirm

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

var request = require("request");

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

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/confirm")

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/billing/subscribe/confirm");

xhr.send(data);

import requests

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

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

setup_intent

string

Setup intent Id

setup_intent_client_secret

string

Setup intent Secret token

source_type

string

Source type (card)

Response

SCA finished or failed (redirect)

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 (light, pro, enterprise)

period

string

Subscription period (monthly, yearly)

nbLicences

number

Number of licences

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

Change subscription

Change subscription plan

patchhttps://api.datananas.com/billing/upgrade

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

var request = require("request");

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

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/upgrade")

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/billing/upgrade");

xhr.send(data);

import requests

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

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

Body Params

plan

string

Subscription plan (light, pro, enterprise)

period

string

Subscription period (monthly, yearly)

nbLicences

number

Number of licences

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

limit

number

Limit to the number of documents to return (between 20 and 50)

page

number

Index of the page to return

reason

array of strings

Property to allow filtering on why a contact has been blacklisted

sort

string

Property to allow to choose results order

type

array of strings

Choose whether to have only domain, email or both

Response

Blacklist 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

Suggest Edits

Coffee

Suggest Edits

Brew coffee

Do its best to brew an excellent coffee

gethttps://api.datananas.com/brew

curl --request GET \
  --url 'https://api.datananas.com/brew?coffee=coffee'

var request = require("request");

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

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/brew?coffee=coffee")

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/brew?coffee=coffee");

xhr.send(data);

import requests

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

querystring = {"coffee":"coffee"}

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

Query Params

coffee

string

required

Type of coffee to brew

Response

what else ?

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

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

DEPRECATED - Add contacts in sequence

This function should be avoided in favor of PATCH /contacts/engage.
Adds 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

Path Params

id

string

required

The id of the campaign

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

createdAt

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

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

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

company_industry

string

Industry of the company

company_size

string

Size of the company

mobile

string

Contact's mobile phone number

vars

object

Key=>value custom variables

zipcode

string

Contact company zipcode

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
stageId	string Optional stage id
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
role	string The prospect's role in its company
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)
companyId	string The id of the company (ObjectId)
groupId	string The group (ObjectId)
date_added	string date of creation
updatedAt	string last update date

Suggest Edits

DEPRECATED - Filter contacts based on multiple criteria

This route should be avoided in favor of POST /contacts/filter
Filter contacts 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

stageId

objectId

Filter contact by stage.

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

createdAt

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

DEPRECATED - Delete multiple contacts

This route should be avoided in favor of DELETE /contacts/filter
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

createdAt

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

Suggest Edits

DEPRECATED - Update multiple contacts

Update status, list or user of multiple contacts.
This function should be avoided in favor of PATCH /contacts/filter

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

Ids of contact to update

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

createdAt

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

integrations

array of strings

List of integrations name to use

Body Params

contactIds

array of strings

An array of contacts id

listId

objectId

Updates to apply

userId

objectId

stageId

objectId

status

string

Response

The contacts will soon be updated

contacts	number The number of contacts updated

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

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 (an additional 'blacklists' property exists)

createdAt	string Date at which the contact has been created
first_name	string The first name of the prospect
last_name	string The last name of the prospect
lastContactedAt	string Last date at which the contact has been contacted
mobile	string contact mobile phone
picture	string The gravatar url
stageId	string Optional stage id
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 according to briteverify: `valid` - The email represents a real account `invalid` - Not a real email `unknown` - cannot verify valid or invalid `accept_all` - domains that respond to all verification request in the affirmative
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
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
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)
companyId	string The id of the company (ObjectId)
groupId	string The group (ObjectId)
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 TO REMOVE AFTER OLD SEARCH REMOVAL
email_score	number The scope of the email address
lastEmailCategory	string The category of the last email sent by the contact
zipcode	string Contact's zipcode

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

stageId

objectId

new stage id

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

company_name

string

The name of the company

company_industry

string

The company type, sector

company_size

string

The size of the company

mobile

string

Contact's mobile phone number

vars

object

A free form object to store additional information

zipcode

string

Contact company zipcode

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
stageId	string Optional stage id
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
role	string The prospect's role in its company
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)
companyId	string The id of the company (ObjectId)
groupId	string The group (ObjectId)
date_added	string date of creation
updatedAt	string last update date

Suggest Edits

DEPRECATED - List owners

This route should be avoided in favor of GET /contacts/users
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

createdAt

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

Pause contact

A contact can be paused in a sequence only if it is still active in it.
Said differently, it means the contact should be in one of the following state:

added
active
replied

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

curl --request PATCH \
  --url 'https://api.datananas.com/contacts/pause/id?campaignId=campaignId'

var request = require("request");

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

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/pause/id?campaignId=campaignId")

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/pause/id?campaignId=campaignId");

xhr.send(data);

import requests

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

querystring = {"campaignId":"campaignId"}

response = requests.request("PATCH", 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

Path Params

id

string

required

Contact id

Query Params

campaignId

objectId

required

Sequence in which the contact will be paused

Response

Contact successfully unpaused

pendingNb	number Number of updated pendings

reason	string Reason why the contact can't be paused: `invalid_state`: Contact state is not a pausable one `not_added`: Contact is not added in the required sequence

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

createdAt	string Date at which the contact has been created
first_name	string The first name of the prospect
last_name	string The last name of the prospect
lastContactedAt	string Last date at which the contact has been contacted
mobile	string contact mobile phone
picture	string The gravatar url
stageId	string Optional stage id
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 according to briteverify: `valid` - The email represents a real account `invalid` - Not a real email `unknown` - cannot verify valid or invalid `accept_all` - domains that respond to all verification request in the affirmative
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
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
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)
companyId	string The id of the company (ObjectId)
groupId	string The group (ObjectId)
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 TO REMOVE AFTER OLD SEARCH REMOVAL
email_score	number The scope of the email address
lastEmailCategory	string The category of the last email sent by the contact
zipcode	string Contact's zipcode

Suggest Edits

Unpause contact

Unpause a contact in a sequence

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

curl --request PATCH \
  --url 'https://api.datananas.com/contacts/unpause/id?campaignId=campaignId'

var request = require("request");

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

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/unpause/id?campaignId=campaignId")

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/unpause/id?campaignId=campaignId");

xhr.send(data);

import requests

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

querystring = {"campaignId":"campaignId"}

response = requests.request("PATCH", 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

Path Params

id

string

required

Contact id

Query Params

campaignId

objectId

required

Sequence in which the contact will be paused

Response

Contact successfully unpaused

pendingNb	number Number of scheduled pendings

Suggest Edits

Check contacts validity

Checks contact validity 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

Body Params

contacts

array of objects

email

owner

Response

The contacts have been checked

existingContacts	array List of contact already existing.
invalidOwner	array List of contact email that have an invalid owner field
invalidCollectedAt	array List of contact with an invalid collectedAt date

Suggest Edits

Create multiple 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

When true, existing contacts will be moved to the list passed in parameter

replaceOwner

boolean

When true, existing contact owner will be replaced by the owner field

Body Params

list

object

list.name

string

If listId is not provided, name of the new list

list.listId

objectId

If name is not provided, list id in which contacts will be added

contacts

array of objects

city

collectedAt

company_industry

company_name

company_size

country

email

first_name

lang

last_name

linkedinurl

phone

role

owner

source

vars

Response

Request received. The contacts will soon be created and/or updated

list	List in which contacts have been added
created	List of created contacts
updated	List of created contacts

Suggest Edits

Count contacts

Count contacts using search filters

posthttps://api.datananas.com/contacts/filter/count

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

var request = require("request");

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

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/filter/count")

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/filter/count");

xhr.send(data);

import requests

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

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

combination

string

How to combine searches

filterId

objectId

Id of the filter to use. Is a priority over a new filter

limit

integer

Maximum number of contact to display

searches

array of arrays

Filters

sort

object

How to sort contacts

sort.index

string

Key name by which results will be sorted

sort.direction

string

Sort order (asc or desc)

Response

Filtered contacts

total	integer Total number of contacts

Suggest Edits

Delete contacts

Delete multiple contacts by filters. If contactIds is present, searches and combination will bi ignored.

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

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

var request = require("request");

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

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/filter")

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/filter");

xhr.send(data);

import requests

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

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

Body Params

combination

string

How to combine searches

contactIds

array of strings

filterId

objectId

Id of the filter to use to select contacts

searches

array of arrays

Filters

Response

Some or all contacts have been deleted successfully

campaignsContacts	object Information about campaigns in which are deleted contacts
campaignsContacts.affected	number Number of affected campaigns
campaignsContacts.deleted	number Number of campaigns removed from contacts
campaignsContacts.updated	number Number of campaigns updated on contacts
contacts	object Contacts related information
contacts.deleted	number Number of updated contacts
pendingEmails	object Information about emails waiting to be sent
pendingEmails.deleted	number Number of deleted emails
tasks	object Information about deleted contacts tasks
tasks.deleted	number Number of deleted tasks

Suggest Edits

Filter contacts

Search contact by filtering them directly with criterias or with a saved filter id.
To have the count of the number of contacts affected by the search, use
POST /contacts/filter/count

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

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

var request = require("request");

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

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/filter")

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/filter");

xhr.send(data);

import requests

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

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

combination

string

How to combine searches

filterId

objectId

Id of the filter to use. Is a priority over a new filter

limit

integer

Maximum number of contact to display

page

integer

Result page number

searches

array of arrays

Filters

sort

object

How to sort contacts

sort.index

string

Key name by which results will be sorted

sort.direction

string

Sort order (asc or desc)

Response

Filtered contacts

Suggest Edits

Update multiple contacts

Update status, list or user of multiple contacts

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

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

var request = require("request");

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

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/filter")

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/filter");

xhr.send(data);

import requests

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

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

Body Params

combination

string

How to combine searches

contactIds

array of strings

An array of contacts id

filterId

objectId

Id of the filter to use to select contacts

integrations

array of strings

List of integrations name to use

listId

objectId

Updates to apply

searches

array of arrays

Filters

sort

object

How to sort contacts

sort.index

string

Key name by which results will be sorted

sort.direction

string

Sort order (asc or desc)

stageId

objectId

status

string

Value of the status to update

userId

objectId

Response

The contacts will soon be updated

updated	number Number of updated 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 filter, with filterId
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.
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/contacts/engage

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

var request = require("request");

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

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/engage")

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/engage");

xhr.send(data);

import requests

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

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

Body Params

campaignId

objectId

Id of the campaign in which contacts will be added

combination

string

How to combine searches

contactIds

array of strings

An array of contacts id

dateStart

string

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

distribution

string

When activating drip with multiple senders, distribution defines how contacts are distributed between senders:

random - Contacts are distributed randomly across senders.
owner - The sender will be the contact's owner, and the distribution was made manually

drip

number

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

filterId

objectId

Id of the filter to use to select contacts

listId

objectId

An id of a list

searches

array of arrays

Filters

senderIds

array of strings

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

Response

Emails are being scheduled

engaged	number The number of contacts added to the campaign

Suggest Edits

Pause contacts

Pause contacts in a sequence

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

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

var request = require("request");

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

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/pause")

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/pause");

xhr.send(data);

import requests

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

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

Body Params

campaignId

objectId

campaign in which contacts will be paused

combination

string

How to combine searches

filterId

objectId

Id of the filter to use to select contacts

searches

array of arrays

Filters

Response

Contacts successfully paused

contactNb	number Number of updated contacts
errors	array List of contact not paused
paused	array List of paused contact ids
pendingNb	number Number of updated pendings

Suggest Edits

Unause contacts

Unpause contacts from sequence

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

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

var request = require("request");

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

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/unpause")

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/unpause");

xhr.send(data);

import requests

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

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

Body Params

campaignId

objectId

campaign in which contacts will be paused

combination

string

How to combine searches

filterId

objectId

Id of the filter to use to select contacts

searches

array of arrays

Filters

Response

Contacts successfully unpaused

contactNb	number Number of updated contacts
errors	array List of contact not unpaused because they were not paused
unpaused	array List of unpaused contact ids
pendingNb	number Number of updated pendings

Suggest Edits

Upgrade contacts

Use the datadesk to clean and upgrade contacts thanks to filters

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

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

var request = require("request");

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

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/datadesk")

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/datadesk");

xhr.send(data);

import requests

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

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

combination

string

How to combine searches

contactIds

array of strings

An array of contacts id

filterId

objectId

Id of the filter to use to select contacts

integrations

array of strings

List of integrations name to use

searches

array of arrays

Filters

Response

Contacts will soo be upgraded

contactNb	number Number of contacts soon upgraded

Suggest Edits

Get contacts owners

Get information about contacts owners

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

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

var request = require("request");

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

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/users")

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/users");

xhr.send(data);

import requests

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

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

combination

string

How to combine searches

contactIds

array of strings

An array of contacts id

filterId

objectId

Id of the filter to use to select contacts

limit

integer

Limit the number of contacts to analyse

searches

array of arrays

Filters

Response

Emails are being scheduled

Suggest Edits

Validate contacts

Check whether contacts can be added in a sequence. We check for:

blacklisted contacts
contacts with missing variables
contacts already added into the sequence
contacts already added into another sequence

At most 100 contacts can be returned for each error type
Only one of contactIds, filterId or searches is mandatory

posthttps://api.datananas.com/contacts/engage/validate

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

var request = require("request");

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

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/engage/validate")

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/engage/validate");

xhr.send(data);

import requests

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

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

combination

string

How to combine searches

contactIds

array of strings

List of contacts to validate

filterId

objectId

Id of the filter to use. Is a priority over a new filter

searches

array of arrays

Filters

Response

List of contacts that can't be engaged

blacklisted	array list of blacklisted contacts
missingVariables	array List of contacts that do not have all the necessary variables
alreadyInThisSequence	array List of contacts already engaged in the selected sequence
alreadyInAnotherSequence	array List of contacts already engaged in another sequence.

Suggest Edits

Create 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

Suggest Edits

Find 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 note

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

Suggest Edits

Get 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

Suggest Edits

Update 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

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

date

Number of day before a campaignContact should be marked as unresponsive

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.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.timeBeforeUnresponsive	string Number of day before a campaignContact should be marked as unresponsive
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.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

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

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.timeBeforeUnresponsive	string Number of day before a campaignContact should be marked as unresponsive
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.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

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

date

Number of day before a campaignContact should be marked as unresponsive

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.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.timeBeforeUnresponsive	string Number of day before a campaignContact should be marked as unresponsive
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.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

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

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.timeBeforeUnresponsive	string Number of day before a campaignContact should be marked as unresponsive
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.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

DEPRECATED - Unsubscribe from all sequences

This function should be avoided in favor of PATCH /contacts/unsubscribe.
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 should also be blacklisted

reason

string

Blacklisting reason

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

createdAt

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

Unsubscribe from all sequences

Unsubscribe multiple contacts from all sequences

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

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

var request = require("request");

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

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/unsubscribe")

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/unsubscribe");

xhr.send(data);

import requests

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

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

Body Params

blacklist

boolean

True if contacts should also be blacklisted

combination

string

How to combine searches

contactIds

array of strings

The ids of the contacts to unsubscribe

filterId

objectId

Id of the filter to use to select contacts

reason

string

Blacklisting reason

searches

array of arrays

Filters

Response

Some or all contacts have been unsubscribed successfully

campaignsContacts	object Information about campaigns oin which are unsubscribed contacts
campaignsContacts.affected	number Number of affected campaigns
campaignsContacts.deleted	number Number of campaigns removed from contacts
campaignsContacts.updated	number Number of campaigns updated on contacts
contacts	object Contacts related information
contacts.updated	number Number of updated contacts
pendingEmails	object Information about emails waiting to be sent
pendingEmails.deleted	number Number of deleted emails
tasks	object Information about unsubscribed contacts tasks
tasks.deleted	number Number of deleted tasks

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
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.datadesk	object
settings.datadesk.cleanNames	boolean Whether the datadesk should clean contacts name
settings.datadesk.cleanRoles	boolean Whether the datadesk should clean contacts role
settings.datadesk.cleanCompanyName	boolean Whether the datadesk should clean contacts company name
settings.datadesk.cleanCompanySize	boolean Whether the datadesk should clean contacts company size
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
settings.customDomain	string Custom domain used for tracking link, opensn and unsubscribe links
integrations	array
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.customDomain

string

Custom domain used for tracking link, opensn and unsubscribe links

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

settings.datadesk

object

Datadesk configuration

settings.datadesk.cleanCompanyName

boolean

Should company names be cleaned

settings.datadesk.cleanCompanySize

boolean

Should company sizes be cleaned

settings.datadesk.cleanNames

boolean

Should first and last names be cleaned

settings.datadesk.cleanRoles

boolean

Should roles be cleaned

settings.datadesk.magicVariables

object

Magic Variables Settings

settings.datadesk.magicVariables.civility

object

Generate civility

settings.datadesk.magicVariables.full_civility

object

Generate full civility

settings.datadesk.magicVariables.zipcode

object

Generate zipcode

settings.datadesk.magicVariables.department_name

object

Generate departement

settings.datadesk.magicVariables.chief_place

object

Generate chief place

settings.datadesk.magicVariables.department_inside

object

Generate department with prefix inside

settings.datadesk.magicVariables.department_direction

object

Generate department with prefix direction

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
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.datadesk	object
settings.datadesk.cleanNames	boolean Whether the datadesk should clean contacts name
settings.datadesk.cleanRoles	boolean Whether the datadesk should clean contacts role
settings.datadesk.cleanCompanyName	boolean Whether the datadesk should clean contacts company name
settings.datadesk.cleanCompanySize	boolean Whether the datadesk should clean contacts company size
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
settings.customDomain	string Custom domain used for tracking link, opensn and unsubscribe links
integrations	array
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 Number of contacts [quota, number]
contact_connect	array Number of contacts added with Connect this day [quota, number]
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)

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

Query Params

200Response

OAuth2 Auth

Query Params

302400403Response

OAuth2 Auth

Body Params

201402409422424Response

OAuth2 Auth

Body Params

201402422503Response

OAuth2 Auth

Body Params

201Response

OAuth2 Auth

Query Params

200Response

OAuth2 Auth

Path Params

202403404Response

Query Params

418Response

OAuth2 Auth

200403Response

Body Params

200Response

OAuth2 Auth

Path Params

Query Params

Body Params

200402403404422424Response

OAuth2 Auth

Path Params

200403404424Response

OAuth2 Auth

Body Params

200402403409424Response

OAuth2 Auth

Query Params

200Response

OAuth2 Auth

Query Params

202403404Response

OAuth2 Auth

Query Params

Body Params

202404Response

OAuth2 Auth

Path Params

202403404Response

OAuth2 Auth

Path Params

200404Response

OAuth2 Auth

Path Params

Body Params

200404409424Response

OAuth2 Auth

Query Params

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