Contacts
Update a contact
PATCH
/
v1
/
contacts
/
{id}
Update a contact
curl --request PATCH \
--url https://api-us.larynth.com/v1/contacts/{id} \
--header 'Content-Type: application/json' \
--cookie __Host-lx_session= \
--data '
{
"attributes": {},
"country": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"region": "<string>",
"tags": [
"<string>"
],
"timezone": "<string>"
}
'import requests
url = "https://api-us.larynth.com/v1/contacts/{id}"
payload = {
"attributes": {},
"country": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"region": "<string>",
"tags": ["<string>"],
"timezone": "<string>"
}
headers = {
"cookie": "__Host-lx_session=",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {cookie: '__Host-lx_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
attributes: {},
country: '<string>',
first_name: '<string>',
last_name: '<string>',
region: '<string>',
tags: ['<string>'],
timezone: '<string>'
})
};
fetch('https://api-us.larynth.com/v1/contacts/{id}', 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://api-us.larynth.com/v1/contacts/{id}",
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([
'attributes' => [
],
'country' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'region' => '<string>',
'tags' => [
'<string>'
],
'timezone' => '<string>'
]),
CURLOPT_COOKIE => "__Host-lx_session=",
CURLOPT_HTTPHEADER => [
"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://api-us.larynth.com/v1/contacts/{id}"
payload := strings.NewReader("{\n \"attributes\": {},\n \"country\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"region\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"timezone\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("cookie", "__Host-lx_session=")
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://api-us.larynth.com/v1/contacts/{id}")
.header("cookie", "__Host-lx_session=")
.header("Content-Type", "application/json")
.body("{\n \"attributes\": {},\n \"country\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"region\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-us.larynth.com/v1/contacts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["cookie"] = '__Host-lx_session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"attributes\": {},\n \"country\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"region\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"timezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"attributes": {},
"created_at": "2023-11-07T05:31:56Z",
"e164": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z",
"callable": {
"informational": true,
"marketing": true
},
"consent_summary": "written",
"country": "<string>",
"dnc": {
"listed": true,
"sources": [
"<string>"
]
},
"first_name": "<string>",
"import_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_contact": {
"at": "2023-11-07T05:31:56Z",
"call_id": "<string>",
"direction": "inbound"
},
"last_name": "<string>",
"name": "<string>",
"region": "<string>",
"region_resolved": "<string>",
"relationship": "existing",
"source": "manual",
"tags": [
"<string>"
],
"timezone": "<string>",
"timezone_resolved": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}Authorizations
sessionapiKey
Dashboard session cookie
Path Parameters
Body
application/json
Show child attributes
Show child attributes
Pattern:
^[A-Z]{2}$Maximum string length:
100Maximum string length:
100Maximum string length:
16Available options:
existing, none Replaces the tags when present
Maximum array length:
20Maximum string length:
64Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
written, express, none, opted_out On createContact this is the check made at creation
Show child attributes
Show child attributes
Show child attributes
Show child attributes
First and last name joined; empty when unknown
existing means an established relationship (California preamble rule)
Available options:
existing, none Available options:
manual, import, api, inbound_call Contact time zone, else the area code's single zone; empty means the contact is not dialed
⌘I
Update a contact
curl --request PATCH \
--url https://api-us.larynth.com/v1/contacts/{id} \
--header 'Content-Type: application/json' \
--cookie __Host-lx_session= \
--data '
{
"attributes": {},
"country": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"region": "<string>",
"tags": [
"<string>"
],
"timezone": "<string>"
}
'import requests
url = "https://api-us.larynth.com/v1/contacts/{id}"
payload = {
"attributes": {},
"country": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"region": "<string>",
"tags": ["<string>"],
"timezone": "<string>"
}
headers = {
"cookie": "__Host-lx_session=",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {cookie: '__Host-lx_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
attributes: {},
country: '<string>',
first_name: '<string>',
last_name: '<string>',
region: '<string>',
tags: ['<string>'],
timezone: '<string>'
})
};
fetch('https://api-us.larynth.com/v1/contacts/{id}', 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://api-us.larynth.com/v1/contacts/{id}",
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([
'attributes' => [
],
'country' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'region' => '<string>',
'tags' => [
'<string>'
],
'timezone' => '<string>'
]),
CURLOPT_COOKIE => "__Host-lx_session=",
CURLOPT_HTTPHEADER => [
"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://api-us.larynth.com/v1/contacts/{id}"
payload := strings.NewReader("{\n \"attributes\": {},\n \"country\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"region\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"timezone\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("cookie", "__Host-lx_session=")
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://api-us.larynth.com/v1/contacts/{id}")
.header("cookie", "__Host-lx_session=")
.header("Content-Type", "application/json")
.body("{\n \"attributes\": {},\n \"country\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"region\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-us.larynth.com/v1/contacts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["cookie"] = '__Host-lx_session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"attributes\": {},\n \"country\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"region\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"timezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"attributes": {},
"created_at": "2023-11-07T05:31:56Z",
"e164": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z",
"callable": {
"informational": true,
"marketing": true
},
"consent_summary": "written",
"country": "<string>",
"dnc": {
"listed": true,
"sources": [
"<string>"
]
},
"first_name": "<string>",
"import_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_contact": {
"at": "2023-11-07T05:31:56Z",
"call_id": "<string>",
"direction": "inbound"
},
"last_name": "<string>",
"name": "<string>",
"region": "<string>",
"region_resolved": "<string>",
"relationship": "existing",
"source": "manual",
"tags": [
"<string>"
],
"timezone": "<string>",
"timezone_resolved": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"api_base": "<string>",
"attempts_left": 123,
"campaign_ids": [
"<string>"
],
"checks": [
{
"code": "platform_outbound_open",
"state": "ok",
"fix": {
"kind": "link",
"target": "<string>"
},
"params": {}
}
],
"contact_id": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"optout_line": true,
"reauth_methods": [
"<string>"
],
"request_kind": "number_purchase",
"retry_at": "2023-11-07T05:31:56Z",
"revision": 123,
"updated_by_name": "<string>"
}