SendinBlue API Doc

Developers can access their process information, using this API. For example, if you import a file from import_users(), in output you will receive process id. As this process runs in background, to know its current status you can use following operations supported by this API. Possible values of “processes.status” in output data are: queued, in_process & completed.

Get all processes

This API call will let you access all the processes information under the account.

Input Parameter	Description
page	Maximum number of records per request is 50, if there are more than 50 processes then you can use this parameter to get next 50 results [Mandatory].
page_limit	This should be a valid number between 1-50 [Mandatory].

Example :

curl -H 'api-key:your_access_key' -X GET -d '{"page":1,"page_limit":3}' 'https://api.sendinblue.com/v2.0/process'

1	curl -H 'api-key:your_access_key' -X GET -d '{"page":1,"page_limit":3}' 'https://api.sendinblue.com/v2.0/process'

    require('../mailin.php');
    $mailin = new Mailin("https://api.sendinblue.com/v2.0","Your access key");
    $data = array( "page" => 1,
      "page_limit" => 3
    );

    var_dump($mailin->get_processes($data));

require('../mailin.php');

$mailin = new Mailin("https://api.sendinblue.com/v2.0","Your access key");

$data = array( "page" => 1,

"page_limit" => 3

);

var_dump($mailin->get_processes($data));

    require './mailin.rb'
    m = Mailin.new("https://api.sendinblue.com/v2.0","your access key")
    data = { "page" => 1,
      "page_limit" => 3
    }

    result = m.get_processes(data)
    puts result

require './mailin.rb'

m = Mailin.new("https://api.sendinblue.com/v2.0","your access key")

data = { "page" => 1,

"page_limit" => 3

}

result = m.get_processes(data)

puts result

    from mailin import Mailin
    m = Mailin("https://api.sendinblue.com/v2.0","your access key")
    data = { "page" : 1,
      "page_limit" : 3
    }

    result = m.get_processes(data)
    print(result)

from mailin import Mailin

m = Mailin("https://api.sendinblue.com/v2.0","your access key")

data = { "page" : 1,

"page_limit" : 3

}

result = m.get_processes(data)

print(result)

    require("../mailin.js");
    var client = new Mailin("https://api.sendinblue.com/v2.0","your access key");
    data = { "page" : 1,
      "page_limit" : 3
    }

    client.get_processes(data).on('complete', function(data) {
      console.log(data);
    });

require("../mailin.js");

var client = new Mailin("https://api.sendinblue.com/v2.0","your access key");

data = { "page" : 1,

"page_limit" : 3

}

client.get_processes(data).on('complete', function(data) {

console.log(data);

});

    using System;     
    using System.Collections.Generic;
    using mailinblue;

    namespace SendinblueTest
    {
      class Program
      {
        static void Main(string[] args)
        {
			API sendinBlue = new mailinblue.API("your access key");
			Dictionary<string, int> data = new Dictionary<string, int>();
			data.Add("page", 1);
			data.Add("page_limit", 10);

			Object getProcesses = sendinBlue.get_processes(data);
			Console.WriteLine(getProcesses);
        }
      }
    }

using System;

using System.Collections.Generic;

using mailinblue;

namespace SendinblueTest

{

class Program

{

static void Main(string[] args)

{

API sendinBlue = new mailinblue.API("your access key");

Dictionary<string, int> data = new Dictionary<string, int>();

data.Add("page", 1);

data.Add("page_limit", 10);

Object getProcesses = sendinBlue.get_processes(data);

Console.WriteLine(getProcesses);

}

    import java.util.*;
    public class JavaAPI {
      public static void main(String[] args) {
        Mailin http = new Mailin("https://api.sendinblue.com/v2.0","your access key");
        Map < String, Object > data = new HashMap < String, Object > ();
          data.put("page", 1);
          data.put("page_limit", 10);

        String str = http.get_processes(data);
        System.out.println(str);
      }
    }

import java.util.*;

public class JavaAPI {

public static void main(String[] args) {

Mailin http = new Mailin("https://api.sendinblue.com/v2.0","your access key");

Map < String, Object > data = new HashMap < String, Object > ();

data.put("page", 1);

data.put("page_limit", 10);

String str = http.get_processes(data);

System.out.println(str);

}

Sample Output :

{ 
  "code":"success",
  "message":"Successfully retrieved process details",
  "data":{
    "processes":[
      {
        "id": 126,
        "status": "completed",
        "name": "CAMPAIGN_USER_DETAILS",
      },
      {
        "id": 125,
        "status": "in_process",
        "name": "IMPORTUSER"
      },
      {
        "id": 124,
        "status": "queued",
        "name": "SEARCH_UNSUBSCRIBE_USERS",
      }
    ],
    "page":1,
    "page_limit":3,
    "total_process_records":100
  }
}

{

"code":"success",

"message":"Successfully retrieved process details",

"data":{

"processes":[

{

"id": 126,

"status": "completed",

"name": "CAMPAIGN_USER_DETAILS",

{

"id": 125,

"status": "in_process",

"name": "IMPORTUSER"

{

"id": 124,

"status": "queued",

"name": "SEARCH_UNSUBSCRIBE_USERS",

}

"page":1,

"page_limit":3,

"total_process_records":100

}

Get a specific process

This API call will let you access the specific process information.

Input Parameter	Description
id	Id of process to get details [Mandatory].

Example :

curl -H 'api-key:your_access_key' -X GET 'https://api.sendinblue.com/v2.0/process/10'

1	curl -H 'api-key:your_access_key' -X GET 'https://api.sendinblue.com/v2.0/process/10'

		require('../mailin.php');
		$mailin = new Mailin("https://api.sendinblue.com/v2.0","Your access key");
    $data = array( "id"=>10 );

    var_dump($mailin->get_process($data));

require('../mailin.php');

$mailin = new Mailin("https://api.sendinblue.com/v2.0","Your access key");

$data = array( "id"=>10 );

var_dump($mailin->get_process($data));

    require './mailin.rb'
    m = Mailin.new("https://api.sendinblue.com/v2.0","your access key")
    data = { "id" => 10 }

    result = m.get_process(data)
    puts result

require './mailin.rb'

m = Mailin.new("https://api.sendinblue.com/v2.0","your access key")

data = { "id" => 10 }

result = m.get_process(data)

puts result

		from mailin import Mailin
		m = Mailin("https://api.sendinblue.com/v2.0","Your access key")
    data = { "id" : 10 }

    result = m.get_process(data)
		print(result)

from mailin import Mailin

m = Mailin("https://api.sendinblue.com/v2.0","Your access key")

data = { "id" : 10 }

result = m.get_process(data)

print(result)

    require("../mailin.js");
    var client = new Mailin("https://api.sendinblue.com/v2.0","Your access key");
    data = { "id" : 10 }

    client.get_process(data).on('complete', function(data) {
      console.log(data);
    });

require("../mailin.js");

var client = new Mailin("https://api.sendinblue.com/v2.0","Your access key");

data = { "id" : 10 }

client.get_process(data).on('complete', function(data) {

console.log(data);

});

		using System;     
		using System.Collections.Generic;
		using mailinblue;

		namespace SendinblueTest
		{
		    class Program
		    {
		        static void Main(string[] args)
		        {
			API sendinBlue = new mailinblue.API("your access key");
			Dictionary<string, int> data = new Dictionary<string, int>();
			data.Add("id", 10);

			Object getProcess = sendinBlue.get_process(data);
			Console.WriteLine(getProcess);
		        }
		    }
		}

using System;

using System.Collections.Generic;

using mailinblue;

namespace SendinblueTest

{

class Program

{

static void Main(string[] args)

{

API sendinBlue = new mailinblue.API("your access key");

Dictionary<string, int> data = new Dictionary<string, int>();

data.Add("id", 10);

Object getProcess = sendinBlue.get_process(data);

Console.WriteLine(getProcess);

}

    import java.util.*;
      public class JavaAPI {
      public static void main(String[] args) {
        Mailin http = new Mailin("https://api.sendinblue.com/v2.0","your access key");
        Map < String, Object > data = new HashMap < String, Object > ();
          data.put("id", 10);

        String str = http.get_process(data);
        System.out.println(str);
      }
    }

import java.util.*;

public class JavaAPI {

public static void main(String[] args) {

Mailin http = new Mailin("https://api.sendinblue.com/v2.0","your access key");

Map < String, Object > data = new HashMap < String, Object > ();

data.put("id", 10);

String str = http.get_process(data);

System.out.println(str);

}

Sample Output :

	{
		"code": "success",
		"message" : "Data retrieved for process",
		"data" :  
		{
			"id": 10,
			"status": "completed",
			"name": "IMPORTUSER"
		}
	}

{

"code": "success",

"message" : "Data retrieved for process",

"data" :

{

"id": 10,

"status": "completed",

"name": "IMPORTUSER"

}