Update recipient

curl --request PATCH \
  --url https://campaigns.sightx.io/campaigns-service/v1/recipients/{recipientId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "",
  "recipientListId": "5f62a3cce1561600514e1c79",
  "email": "jesustodelete@mailinator.com",
  "isUnsubscribed": false,
  "values": {
    "0": 500,
    "1": "Jesus",
    "2": "Deleted",
    "3": "jesustodelete@mailinator.com",
    "4": "222222222",
    "5": "Male",
    "6": "Venezuela",
    "7": "Zulia"
  }
}
'

import requests

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

payload = {
    "phone": "",
    "recipientListId": "5f62a3cce1561600514e1c79",
    "email": "jesustodelete@mailinator.com",
    "isUnsubscribed": False,
    "values": {
        "0": 500,
        "1": "Jesus",
        "2": "Deleted",
        "3": "jesustodelete@mailinator.com",
        "4": "222222222",
        "5": "Male",
        "6": "Venezuela",
        "7": "Zulia"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    phone: '',
    recipientListId: '5f62a3cce1561600514e1c79',
    email: 'jesustodelete@mailinator.com',
    isUnsubscribed: false,
    values: {
      '0': 500,
      '1': 'Jesus',
      '2': 'Deleted',
      '3': 'jesustodelete@mailinator.com',
      '4': '222222222',
      '5': 'Male',
      '6': 'Venezuela',
      '7': 'Zulia'
    }
  })
};

fetch('https://campaigns.sightx.io/campaigns-service/v1/recipients/{recipientId}', 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/recipients/{recipientId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'phone' => '',
    'recipientListId' => '5f62a3cce1561600514e1c79',
    'email' => 'jesustodelete@mailinator.com',
    'isUnsubscribed' => false,
    'values' => [
        '0' => 500,
        '1' => 'Jesus',
        '2' => 'Deleted',
        '3' => 'jesustodelete@mailinator.com',
        '4' => '222222222',
        '5' => 'Male',
        '6' => 'Venezuela',
        '7' => 'Zulia'
    ]
  ]),
  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/recipients/{recipientId}"

	payload := strings.NewReader("{\n  \"phone\": \"\",\n  \"recipientListId\": \"5f62a3cce1561600514e1c79\",\n  \"email\": \"jesustodelete@mailinator.com\",\n  \"isUnsubscribed\": false,\n  \"values\": {\n    \"0\": 500,\n    \"1\": \"Jesus\",\n    \"2\": \"Deleted\",\n    \"3\": \"jesustodelete@mailinator.com\",\n    \"4\": \"222222222\",\n    \"5\": \"Male\",\n    \"6\": \"Venezuela\",\n    \"7\": \"Zulia\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://campaigns.sightx.io/campaigns-service/v1/recipients/{recipientId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone\": \"\",\n  \"recipientListId\": \"5f62a3cce1561600514e1c79\",\n  \"email\": \"jesustodelete@mailinator.com\",\n  \"isUnsubscribed\": false,\n  \"values\": {\n    \"0\": 500,\n    \"1\": \"Jesus\",\n    \"2\": \"Deleted\",\n    \"3\": \"jesustodelete@mailinator.com\",\n    \"4\": \"222222222\",\n    \"5\": \"Male\",\n    \"6\": \"Venezuela\",\n    \"7\": \"Zulia\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone\": \"\",\n  \"recipientListId\": \"5f62a3cce1561600514e1c79\",\n  \"email\": \"jesustodelete@mailinator.com\",\n  \"isUnsubscribed\": false,\n  \"values\": {\n    \"0\": 500,\n    \"1\": \"Jesus\",\n    \"2\": \"Deleted\",\n    \"3\": \"jesustodelete@mailinator.com\",\n    \"4\": \"222222222\",\n    \"5\": \"Male\",\n    \"6\": \"Venezuela\",\n    \"7\": \"Zulia\"\n  }\n}"

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

Audiences/Recipient lists / Recipient lists

Update recipient

Description

Update a recipient where recipientId is the id of the recipient to be updated.

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.

PATCH

campaigns-service

recipients

{recipientId}

Update recipient

curl --request PATCH \
  --url https://campaigns.sightx.io/campaigns-service/v1/recipients/{recipientId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "",
  "recipientListId": "5f62a3cce1561600514e1c79",
  "email": "jesustodelete@mailinator.com",
  "isUnsubscribed": false,
  "values": {
    "0": 500,
    "1": "Jesus",
    "2": "Deleted",
    "3": "jesustodelete@mailinator.com",
    "4": "222222222",
    "5": "Male",
    "6": "Venezuela",
    "7": "Zulia"
  }
}
'

import requests

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

payload = {
    "phone": "",
    "recipientListId": "5f62a3cce1561600514e1c79",
    "email": "jesustodelete@mailinator.com",
    "isUnsubscribed": False,
    "values": {
        "0": 500,
        "1": "Jesus",
        "2": "Deleted",
        "3": "jesustodelete@mailinator.com",
        "4": "222222222",
        "5": "Male",
        "6": "Venezuela",
        "7": "Zulia"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    phone: '',
    recipientListId: '5f62a3cce1561600514e1c79',
    email: 'jesustodelete@mailinator.com',
    isUnsubscribed: false,
    values: {
      '0': 500,
      '1': 'Jesus',
      '2': 'Deleted',
      '3': 'jesustodelete@mailinator.com',
      '4': '222222222',
      '5': 'Male',
      '6': 'Venezuela',
      '7': 'Zulia'
    }
  })
};

fetch('https://campaigns.sightx.io/campaigns-service/v1/recipients/{recipientId}', 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/recipients/{recipientId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'phone' => '',
    'recipientListId' => '5f62a3cce1561600514e1c79',
    'email' => 'jesustodelete@mailinator.com',
    'isUnsubscribed' => false,
    'values' => [
        '0' => 500,
        '1' => 'Jesus',
        '2' => 'Deleted',
        '3' => 'jesustodelete@mailinator.com',
        '4' => '222222222',
        '5' => 'Male',
        '6' => 'Venezuela',
        '7' => 'Zulia'
    ]
  ]),
  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/recipients/{recipientId}"

	payload := strings.NewReader("{\n  \"phone\": \"\",\n  \"recipientListId\": \"5f62a3cce1561600514e1c79\",\n  \"email\": \"jesustodelete@mailinator.com\",\n  \"isUnsubscribed\": false,\n  \"values\": {\n    \"0\": 500,\n    \"1\": \"Jesus\",\n    \"2\": \"Deleted\",\n    \"3\": \"jesustodelete@mailinator.com\",\n    \"4\": \"222222222\",\n    \"5\": \"Male\",\n    \"6\": \"Venezuela\",\n    \"7\": \"Zulia\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://campaigns.sightx.io/campaigns-service/v1/recipients/{recipientId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone\": \"\",\n  \"recipientListId\": \"5f62a3cce1561600514e1c79\",\n  \"email\": \"jesustodelete@mailinator.com\",\n  \"isUnsubscribed\": false,\n  \"values\": {\n    \"0\": 500,\n    \"1\": \"Jesus\",\n    \"2\": \"Deleted\",\n    \"3\": \"jesustodelete@mailinator.com\",\n    \"4\": \"222222222\",\n    \"5\": \"Male\",\n    \"6\": \"Venezuela\",\n    \"7\": \"Zulia\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone\": \"\",\n  \"recipientListId\": \"5f62a3cce1561600514e1c79\",\n  \"email\": \"jesustodelete@mailinator.com\",\n  \"isUnsubscribed\": false,\n  \"values\": {\n    \"0\": 500,\n    \"1\": \"Jesus\",\n    \"2\": \"Deleted\",\n    \"3\": \"jesustodelete@mailinator.com\",\n    \"4\": \"222222222\",\n    \"5\": \"Male\",\n    \"6\": \"Venezuela\",\n    \"7\": \"Zulia\"\n  }\n}"

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

Description

Update a recipient where recipientId is the id of the recipient to be updated.

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

Update recipient subscription Unsubscribe a Recipient

⌘I

​Description

​Body

​Response

Authorizations

Headers

Body

Response

Description

Body

Response