Create Recipient list recipient

curl --request POST \
  --url https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "phone",
  "email": "email",
  "recipientListId": "recipient list id",
  "isUnsubscribed": false,
  "values": {
    "0": "first column",
    "1": "second column",
    "2": "third column"
  }
}
'

import requests

url = "https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients"

payload = {
    "phone": "phone",
    "email": "email",
    "recipientListId": "recipient list id",
    "isUnsubscribed": False,
    "values": {
        "0": "first column",
        "1": "second column",
        "2": "third column"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    phone: 'phone',
    email: 'email',
    recipientListId: 'recipient list id',
    isUnsubscribed: false,
    values: {'0': 'first column', '1': 'second column', '2': 'third column'}
  })
};

fetch('https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'phone' => 'phone',
    'email' => 'email',
    'recipientListId' => 'recipient list id',
    'isUnsubscribed' => false,
    'values' => [
        '0' => 'first column',
        '1' => 'second column',
        '2' => 'third column'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients"

	payload := strings.NewReader("{\n  \"phone\": \"phone\",\n  \"email\": \"email\",\n  \"recipientListId\": \"recipient list id\",\n  \"isUnsubscribed\": false,\n  \"values\": {\n    \"0\": \"first column\",\n    \"1\": \"second column\",\n    \"2\": \"third column\"\n  }\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone\": \"phone\",\n  \"email\": \"email\",\n  \"recipientListId\": \"recipient list id\",\n  \"isUnsubscribed\": false,\n  \"values\": {\n    \"0\": \"first column\",\n    \"1\": \"second column\",\n    \"2\": \"third column\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone\": \"phone\",\n  \"email\": \"email\",\n  \"recipientListId\": \"recipient list id\",\n  \"isUnsubscribed\": false,\n  \"values\": {\n    \"0\": \"first column\",\n    \"1\": \"second column\",\n    \"2\": \"third column\"\n  }\n}"

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

Audiences/Recipient lists / Recipient lists

Create Recipient list recipient

Description

Create a recipient where recipientListId is the id of the recipient list that the recipient will be added.

Body

{
    "phone": string,
    "email": string,
    "recipientListId": string,
    "isUnsubscribed": boolean,
    "values": object,
}

where:

phone: Recipient phone.
email: Recipient email.
recipientListId: Recipient list id.
isUnsubscribed: Flag to prevent sending emails to the recipient.
values: Object indexed by column number with the recipient data.

Response

{
    "email: "email",
    "phone": "phone",
    "isDeleted": false,
    "isUnsubscribed": false,
    "values": {
        "0": "first column,
        "1": "second column",
        "2": "third column",
    },
    "id": "recipient id",
    "recipientListId": "recipient list id"
}

where:

phone: Recipient phone.
email: Recipient email.
recipientListId: Recipient list id.
isUnsubscribed: Flag to prevent sending emails to the recipient.
values: Object indexed by column number with the recipient data.
id: Recipient id.
recipientListId: Recipient list id.

POST

campaigns-service

recipientLists

{recipientListId}

recipients

Create Recipient list recipient

curl --request POST \
  --url https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "phone",
  "email": "email",
  "recipientListId": "recipient list id",
  "isUnsubscribed": false,
  "values": {
    "0": "first column",
    "1": "second column",
    "2": "third column"
  }
}
'

import requests

url = "https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients"

payload = {
    "phone": "phone",
    "email": "email",
    "recipientListId": "recipient list id",
    "isUnsubscribed": False,
    "values": {
        "0": "first column",
        "1": "second column",
        "2": "third column"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    phone: 'phone',
    email: 'email',
    recipientListId: 'recipient list id',
    isUnsubscribed: false,
    values: {'0': 'first column', '1': 'second column', '2': 'third column'}
  })
};

fetch('https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'phone' => 'phone',
    'email' => 'email',
    'recipientListId' => 'recipient list id',
    'isUnsubscribed' => false,
    'values' => [
        '0' => 'first column',
        '1' => 'second column',
        '2' => 'third column'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients"

	payload := strings.NewReader("{\n  \"phone\": \"phone\",\n  \"email\": \"email\",\n  \"recipientListId\": \"recipient list id\",\n  \"isUnsubscribed\": false,\n  \"values\": {\n    \"0\": \"first column\",\n    \"1\": \"second column\",\n    \"2\": \"third column\"\n  }\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone\": \"phone\",\n  \"email\": \"email\",\n  \"recipientListId\": \"recipient list id\",\n  \"isUnsubscribed\": false,\n  \"values\": {\n    \"0\": \"first column\",\n    \"1\": \"second column\",\n    \"2\": \"third column\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone\": \"phone\",\n  \"email\": \"email\",\n  \"recipientListId\": \"recipient list id\",\n  \"isUnsubscribed\": false,\n  \"values\": {\n    \"0\": \"first column\",\n    \"1\": \"second column\",\n    \"2\": \"third column\"\n  }\n}"

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

Description

Create a recipient where recipientListId is the id of the recipient list that the recipient will be added.

Body

{
    "phone": string,
    "email": string,
    "recipientListId": string,
    "isUnsubscribed": boolean,
    "values": object,
}

where:

phone: Recipient phone.
email: Recipient email.
recipientListId: Recipient list id.
isUnsubscribed: Flag to prevent sending emails to the recipient.
values: Object indexed by column number with the recipient data.

Response

{
    "email: "email",
    "phone": "phone",
    "isDeleted": false,
    "isUnsubscribed": false,
    "values": {
        "0": "first column,
        "1": "second column",
        "2": "third column",
    },
    "id": "recipient id",
    "recipientListId": "recipient list id"
}

where:

phone: Recipient phone.
email: Recipient email.
recipientListId: Recipient list id.
isUnsubscribed: Flag to prevent sending emails to the recipient.
values: Object indexed by column number with the recipient data.
id: Recipient id.
recipientListId: Recipient list id.

Authorizations

Authorization

string

header

required

Access token obtained from the m2m-token endpoint.

Headers

Authorization

string

required

Body

application/json

The body is of type object.

Response

Successful response

Delete Recipient List Post v1 recipientlists create

⌘I

​Description

​Body

​Response

Authorizations

Headers

Body

Response

Description

Body

Response