Sendible API

Administration

Create Custom Field

Open in API Explorer
POST /v2/custom_field.json

Create a custom field.

Example Request

Format:
curl --request POST \
  --url 'https://api.sendible.com/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&field_title=test&category=contact&field_type=list&sort_order=1&mandatory=0' \
  --header 'accept: application/json' \
  --header 'authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l' \
  --header 'content-type: multipart/form-data; boundary=---011000010111000001101001'
require 'uri'
require 'net/http'

url = URI("https://api.sendible.com/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&field_title=test&category=contact&field_type=list&sort_order=1&mandatory=0")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["authorization"] = 'Basic QWxhZGRpbjpPcGVuU2VzYW1l'
request["content-type"] = 'multipart/form-data; boundary=---011000010111000001101001'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "POST",
  "hostname": "api.sendible.com",
  "port": null,
  "path": "/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&field_title=test&category=contact&field_type=list&sort_order=1&mandatory=0",
  "headers": {
    "accept": "application/json",
    "authorization": "Basic QWxhZGRpbjpPcGVuU2VzYW1l",
    "content-type": "multipart/form-data; boundary=---011000010111000001101001"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api.sendible.com")

payload = ""

headers = {
    'accept': "application/json",
    'authorization': "Basic QWxhZGRpbjpPcGVuU2VzYW1l",
    'content-type': "multipart/form-data; boundary=---011000010111000001101001"
    }

conn.request("POST", "/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&field_title=test&category=contact&field_type=list&sort_order=1&mandatory=0", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.sendible.com/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&field_title=test&category=contact&field_type=list&sort_order=1&mandatory=0",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l",
    "content-type: multipart/form-data; boundary=---011000010111000001101001"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.sendible.com/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&field_title=test&category=contact&field_type=list&sort_order=1&mandatory=0"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("authorization", "Basic QWxhZGRpbjpPcGVuU2VzYW1l")
	req.Header.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Query Parameters

Name Type Required Description Example
application_id String Required

Your developer application id. This was provided to you via email.

4b634537cc392cca820b61dab08
field_title String Required

Title of custom field.

test
category String Required

The custom field category. Possible values are contact, user, account

contact
field_type String Required

The type of field. Possible values are textarea, password, list, date, time, url, numeric.

list
sort_order Number Required

A numeric value representing the order that this field appears in.

1
mandatory Number Required

Specifies whether this field is mandatory or not. Possible values are 1 or 0.

0

Responses

default Default

Unknown

(Empty Response)

Update Custom Fields Order

Open in API Explorer
PUT /v2/custom_field_order.json

Update the order in which custom fields are displayed.

Example Request

Format:
curl --request PUT \
  --url 'https://api.sendible.com/api/v2/custom_field_order.json?application_id=4b634537cc392cca820b61dab08&custom_field_ids=101102103&category=contact' \
  --header 'accept: application/json' \
  --header 'authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l' \
  --header 'content-type: multipart/form-data; boundary=---011000010111000001101001'
require 'uri'
require 'net/http'

url = URI("https://api.sendible.com/api/v2/custom_field_order.json?application_id=4b634537cc392cca820b61dab08&custom_field_ids=101102103&category=contact")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Put.new(url)
request["accept"] = 'application/json'
request["authorization"] = 'Basic QWxhZGRpbjpPcGVuU2VzYW1l'
request["content-type"] = 'multipart/form-data; boundary=---011000010111000001101001'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "api.sendible.com",
  "port": null,
  "path": "/api/v2/custom_field_order.json?application_id=4b634537cc392cca820b61dab08&custom_field_ids=101102103&category=contact",
  "headers": {
    "accept": "application/json",
    "authorization": "Basic QWxhZGRpbjpPcGVuU2VzYW1l",
    "content-type": "multipart/form-data; boundary=---011000010111000001101001"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api.sendible.com")

payload = ""

headers = {
    'accept': "application/json",
    'authorization': "Basic QWxhZGRpbjpPcGVuU2VzYW1l",
    'content-type': "multipart/form-data; boundary=---011000010111000001101001"
    }

conn.request("PUT", "/api/v2/custom_field_order.json?application_id=4b634537cc392cca820b61dab08&custom_field_ids=101102103&category=contact", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.sendible.com/api/v2/custom_field_order.json?application_id=4b634537cc392cca820b61dab08&custom_field_ids=101102103&category=contact",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l",
    "content-type: multipart/form-data; boundary=---011000010111000001101001"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.sendible.com/api/v2/custom_field_order.json?application_id=4b634537cc392cca820b61dab08&custom_field_ids=101102103&category=contact"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("authorization", "Basic QWxhZGRpbjpPcGVuU2VzYW1l")
	req.Header.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Query Parameters

Name Type Required Description Example
application_id String Required

Your developer application id. This was provided to you via email.

4b634537cc392cca820b61dab08
custom_field_ids String Required

A comma separated list of ID's in the order you need them in.

101102103
category String Required

The custom field category. Possible values are contact, user, account

contact

Responses

default Default

Unknown

(Empty Response)

Delete A Custom Field

Open in API Explorer
DELETE /v2/custom_field.json

Delete a custom field.

Example Request

Format:
curl --request DELETE \
  --url 'https://api.sendible.com/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&custom_field_id=1234' \
  --header 'accept: application/json' \
  --header 'authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l'
require 'uri'
require 'net/http'

url = URI("https://api.sendible.com/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&custom_field_id=1234")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Delete.new(url)
request["accept"] = 'application/json'
request["authorization"] = 'Basic QWxhZGRpbjpPcGVuU2VzYW1l'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "api.sendible.com",
  "port": null,
  "path": "/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&custom_field_id=1234",
  "headers": {
    "accept": "application/json",
    "authorization": "Basic QWxhZGRpbjpPcGVuU2VzYW1l"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api.sendible.com")

headers = {
    'accept': "application/json",
    'authorization': "Basic QWxhZGRpbjpPcGVuU2VzYW1l"
    }

conn.request("DELETE", "/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&custom_field_id=1234", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.sendible.com/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&custom_field_id=1234",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.sendible.com/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&custom_field_id=1234"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("authorization", "Basic QWxhZGRpbjpPcGVuU2VzYW1l")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Query Parameters

Name Type Required Description Example
application_id String Required

Your developer application id. This was provided to you via email.

4b634537cc392cca820b61dab08
custom_field_id Number Required

The ID of the custom field to delete.

1234

Responses

default Default

Unknown

(Empty Response)

Get Custom Fields

Open in API Explorer
GET /v2/custom_fields.json

Retrieve custom fields.

Example Request

Format:
curl --request GET \
  --url 'https://api.sendible.com/api/v2/custom_fields.json?application_id=4b634537cc392cca820b61dab08&category=contact&field_type=list' \
  --header 'accept: application/json' \
  --header 'authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l'
require 'uri'
require 'net/http'

url = URI("https://api.sendible.com/api/v2/custom_fields.json?application_id=4b634537cc392cca820b61dab08&category=contact&field_type=list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = 'Basic QWxhZGRpbjpPcGVuU2VzYW1l'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "GET",
  "hostname": "api.sendible.com",
  "port": null,
  "path": "/api/v2/custom_fields.json?application_id=4b634537cc392cca820b61dab08&category=contact&field_type=list",
  "headers": {
    "accept": "application/json",
    "authorization": "Basic QWxhZGRpbjpPcGVuU2VzYW1l"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api.sendible.com")

headers = {
    'accept': "application/json",
    'authorization': "Basic QWxhZGRpbjpPcGVuU2VzYW1l"
    }

conn.request("GET", "/api/v2/custom_fields.json?application_id=4b634537cc392cca820b61dab08&category=contact&field_type=list", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.sendible.com/api/v2/custom_fields.json?application_id=4b634537cc392cca820b61dab08&category=contact&field_type=list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.sendible.com/api/v2/custom_fields.json?application_id=4b634537cc392cca820b61dab08&category=contact&field_type=list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("authorization", "Basic QWxhZGRpbjpPcGVuU2VzYW1l")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Query Parameters

Name Type Required Description Example
application_id String Required

Your developer application id. This was provided to you via email.

4b634537cc392cca820b61dab08
category String Required

The category of fields to retrieve. Possible values are user, contact or account.

contact
field_type String Optional

Filter by fields of a certain type. Possible values are list, date, time, textarea, numeric.

list

Responses

default Default

Unknown

(Empty Response)

Update Custom Field Value

Open in API Explorer
PUT /v2/custom_fields.json

Update values for custom fields.

Example Request

Format:
curl --request PUT \
  --url 'https://api.sendible.com/api/v2/custom_fields.json?application_id=4b634537cc392cca820b61dab08&category=contact&identifier=1001&field_values=%5B'\''101'\''%3D'\''abc'\''%2C%20'\''102'\''%3D'\''hello'\''%5D' \
  --header 'accept: application/json' \
  --header 'authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l' \
  --header 'content-type: multipart/form-data; boundary=---011000010111000001101001'
require 'uri'
require 'net/http'

url = URI("https://api.sendible.com/api/v2/custom_fields.json?application_id=4b634537cc392cca820b61dab08&category=contact&identifier=1001&field_values=%5B'101'%3D'abc'%2C%20'102'%3D'hello'%5D")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Put.new(url)
request["accept"] = 'application/json'
request["authorization"] = 'Basic QWxhZGRpbjpPcGVuU2VzYW1l'
request["content-type"] = 'multipart/form-data; boundary=---011000010111000001101001'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "api.sendible.com",
  "port": null,
  "path": "/api/v2/custom_fields.json?application_id=4b634537cc392cca820b61dab08&category=contact&identifier=1001&field_values=%5B'101'%3D'abc'%2C%20'102'%3D'hello'%5D",
  "headers": {
    "accept": "application/json",
    "authorization": "Basic QWxhZGRpbjpPcGVuU2VzYW1l",
    "content-type": "multipart/form-data; boundary=---011000010111000001101001"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api.sendible.com")

payload = ""

headers = {
    'accept': "application/json",
    'authorization': "Basic QWxhZGRpbjpPcGVuU2VzYW1l",
    'content-type': "multipart/form-data; boundary=---011000010111000001101001"
    }

conn.request("PUT", "/api/v2/custom_fields.json?application_id=4b634537cc392cca820b61dab08&category=contact&identifier=1001&field_values=%5B'101'%3D'abc'%2C%20'102'%3D'hello'%5D", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.sendible.com/api/v2/custom_fields.json?application_id=4b634537cc392cca820b61dab08&category=contact&identifier=1001&field_values=%5B'101'%3D'abc'%2C%20'102'%3D'hello'%5D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l",
    "content-type: multipart/form-data; boundary=---011000010111000001101001"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.sendible.com/api/v2/custom_fields.json?application_id=4b634537cc392cca820b61dab08&category=contact&identifier=1001&field_values=%5B'101'%3D'abc'%2C%20'102'%3D'hello'%5D"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("authorization", "Basic QWxhZGRpbjpPcGVuU2VzYW1l")
	req.Header.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Query Parameters

Name Type Required Description Example
application_id String Required

Your developer application id. This was provided to you via email.

4b634537cc392cca820b61dab08
category String Required

The category of fields to retrieve. Possible values are user, contact or account.

contact
identifier String Required

The ID of the entity to update. This represents user_id, contact_id or account_id.

1001
field_values String Required

A comma separated list of key value pairs separated by equals. The values should be URL encoded. i.e. field1=value1,field2=value2,field3=value3 Example: twitter_handle=aplusk,blog_url=http%3A%2F%2Fmyblog.com

%5B%27101%27%3D%27abc%27%2C+%27102%27%3D%27hello%27%5D

Responses

default Default

Unknown

(Empty Response)

Update Custom Field

Open in API Explorer
PUT /v2/custom_field.json

Update a custom field.

Example Request

Format:
curl --request PUT \
  --url 'https://api.sendible.com/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&custom_field_id=1234&field_title=test&category=contact&field_type=list&sort_order=1&mandatory=0' \
  --header 'accept: application/json' \
  --header 'authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l' \
  --header 'content-type: multipart/form-data; boundary=---011000010111000001101001'
require 'uri'
require 'net/http'

url = URI("https://api.sendible.com/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&custom_field_id=1234&field_title=test&category=contact&field_type=list&sort_order=1&mandatory=0")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Put.new(url)
request["accept"] = 'application/json'
request["authorization"] = 'Basic QWxhZGRpbjpPcGVuU2VzYW1l'
request["content-type"] = 'multipart/form-data; boundary=---011000010111000001101001'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "api.sendible.com",
  "port": null,
  "path": "/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&custom_field_id=1234&field_title=test&category=contact&field_type=list&sort_order=1&mandatory=0",
  "headers": {
    "accept": "application/json",
    "authorization": "Basic QWxhZGRpbjpPcGVuU2VzYW1l",
    "content-type": "multipart/form-data; boundary=---011000010111000001101001"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api.sendible.com")

payload = ""

headers = {
    'accept': "application/json",
    'authorization': "Basic QWxhZGRpbjpPcGVuU2VzYW1l",
    'content-type': "multipart/form-data; boundary=---011000010111000001101001"
    }

conn.request("PUT", "/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&custom_field_id=1234&field_title=test&category=contact&field_type=list&sort_order=1&mandatory=0", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.sendible.com/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&custom_field_id=1234&field_title=test&category=contact&field_type=list&sort_order=1&mandatory=0",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l",
    "content-type: multipart/form-data; boundary=---011000010111000001101001"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.sendible.com/api/v2/custom_field.json?application_id=4b634537cc392cca820b61dab08&custom_field_id=1234&field_title=test&category=contact&field_type=list&sort_order=1&mandatory=0"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("authorization", "Basic QWxhZGRpbjpPcGVuU2VzYW1l")
	req.Header.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Query Parameters

Name Type Required Description Example
application_id String Required

Your developer application id. This was provided to you via email.

4b634537cc392cca820b61dab08
custom_field_id Number Required

The ID of the custom field to update.

1234
field_title String Required

Title of custom field.

test
category String Required

The custom field category. Possible values are contact, user, account

contact
field_type String Required

The type of field. Possible values are textarea, password, list, date, time, url, numeric.

list
sort_order Number Required

A numeric value representing the order that this field appears in.

1
mandatory Number Required

Specifies whether this field is mandatory or not. Possible values are 1 or 0.

0

Responses

default Default

Unknown

(Empty Response)

Get User Profile

Open in API Explorer
GET /v2/profile.json

Retrieve the user details of the authenticated user.

Example Request

Format:
curl --request GET \
  --url 'https://api.sendible.com/api/v2/profile.json?application_id=4b634537cc392cca820b61dab08' \
  --header 'accept: application/json' \
  --header 'authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l'
require 'uri'
require 'net/http'

url = URI("https://api.sendible.com/api/v2/profile.json?application_id=4b634537cc392cca820b61dab08")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = 'Basic QWxhZGRpbjpPcGVuU2VzYW1l'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "GET",
  "hostname": "api.sendible.com",
  "port": null,
  "path": "/api/v2/profile.json?application_id=4b634537cc392cca820b61dab08",
  "headers": {
    "accept": "application/json",
    "authorization": "Basic QWxhZGRpbjpPcGVuU2VzYW1l"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api.sendible.com")

headers = {
    'accept': "application/json",
    'authorization': "Basic QWxhZGRpbjpPcGVuU2VzYW1l"
    }

conn.request("GET", "/api/v2/profile.json?application_id=4b634537cc392cca820b61dab08", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.sendible.com/api/v2/profile.json?application_id=4b634537cc392cca820b61dab08",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.sendible.com/api/v2/profile.json?application_id=4b634537cc392cca820b61dab08"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("authorization", "Basic QWxhZGRpbjpPcGVuU2VzYW1l")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Query Parameters

Name Type Required Description Example
application_id String Required

Your developer application id. This was provided to you via email.

4b634537cc392cca820b61dab08

Responses

default Default

Unknown

(Empty Response)

Get User Profiles

Open in API Explorer
GET /v1/profiles.json

Retrieves all the user profiles belonging to the authenticated user.

Example Request

Format:
curl --request GET \
  --url 'https://api.sendible.com/api/v1/profiles.json?application_id=4b634537cc392cca820b61dab08' \
  --header 'accept: application/json' \
  --header 'authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l'
require 'uri'
require 'net/http'

url = URI("https://api.sendible.com/api/v1/profiles.json?application_id=4b634537cc392cca820b61dab08")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = 'Basic QWxhZGRpbjpPcGVuU2VzYW1l'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "GET",
  "hostname": "api.sendible.com",
  "port": null,
  "path": "/api/v1/profiles.json?application_id=4b634537cc392cca820b61dab08",
  "headers": {
    "accept": "application/json",
    "authorization": "Basic QWxhZGRpbjpPcGVuU2VzYW1l"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api.sendible.com")

headers = {
    'accept': "application/json",
    'authorization': "Basic QWxhZGRpbjpPcGVuU2VzYW1l"
    }

conn.request("GET", "/api/v1/profiles.json?application_id=4b634537cc392cca820b61dab08", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.sendible.com/api/v1/profiles.json?application_id=4b634537cc392cca820b61dab08",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.sendible.com/api/v1/profiles.json?application_id=4b634537cc392cca820b61dab08"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("authorization", "Basic QWxhZGRpbjpPcGVuU2VzYW1l")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Query Parameters

Name Type Required Description Example
application_id String Required

Your developer application id. This was provided to you via email.

4b634537cc392cca820b61dab08

Responses

default Default

Unknown

(Empty Response)