Correct a person's name or the handles the sequence sends to
curl --request PATCH \
--url http://localhost:8080/sequences/{sequenceId}/contacts/{contactId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "<string>",
"phone": "<string>",
"email": "<string>",
"whatsapp_user_id": "<string>"
}
'import requests
url = "http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}"
payload = {
"display_name": "<string>",
"phone": "<string>",
"email": "<string>",
"whatsapp_user_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
display_name: '<string>',
phone: '<string>',
email: '<string>',
whatsapp_user_id: '<string>'
})
};
fetch('http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}",
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([
'display_name' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'whatsapp_user_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}"
payload := strings.NewReader("{\n \"display_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"whatsapp_user_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"whatsapp_user_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"display_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"whatsapp_user_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"avatar_url": "<string>",
"phone": "<string>",
"email": "<string>",
"whatsapp_user_id": "<string>",
"status": "candidate",
"park_reason": "<string>",
"exit_reason": "<string>",
"fit": 0,
"fit_reason": "<string>",
"batch_key": "<string>",
"source": "<string>",
"next_step_index": 0,
"journey": [
{
"step_index": 0,
"channel": "<string>",
"state": "not_reached",
"at": "2023-11-07T05:31:56Z",
"session_id": "<string>",
"session_ticket_number": 0,
"reason": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"source_detail": "<string>",
"qualification": {
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"judged_at": "2023-11-07T05:31:56Z",
"input_hash": "<string>",
"criteria": {
"must": [
{
"label": "<string>",
"text": "<string>"
}
],
"nice": [
{
"label": "<string>",
"text": "<string>",
"grade": "high"
}
]
},
"verdicts": [
{
"kind": "must",
"label": "<string>",
"text": "<string>",
"verdict": "pass",
"reasoning": "<string>",
"citations": [
{
"enricher": "<string>",
"kind": "<string>",
"id": "<string>"
}
],
"grade": "high"
}
],
"counts": {
"must_total": 0,
"must_passed": 0,
"must_failed": 0,
"must_unsure": 0,
"nice_total": 0,
"nice_weight_total": 0,
"nice_weight_earned": 0,
"nice_unsure": 0
}
},
"enrichment": {},
"next_eligible_at": "2023-11-07T05:31:56Z",
"next_channel": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}People
Correct a person's name or the handles the sequence sends to
Correct a person’s display name, phone, email or WhatsApp user id while they are a candidate or parked. Use to fix bad data before the next send.
PATCH
/
sequences
/
{sequenceId}
/
contacts
/
{contactId}
Correct a person's name or the handles the sequence sends to
curl --request PATCH \
--url http://localhost:8080/sequences/{sequenceId}/contacts/{contactId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "<string>",
"phone": "<string>",
"email": "<string>",
"whatsapp_user_id": "<string>"
}
'import requests
url = "http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}"
payload = {
"display_name": "<string>",
"phone": "<string>",
"email": "<string>",
"whatsapp_user_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
display_name: '<string>',
phone: '<string>',
email: '<string>',
whatsapp_user_id: '<string>'
})
};
fetch('http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}",
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([
'display_name' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'whatsapp_user_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}"
payload := strings.NewReader("{\n \"display_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"whatsapp_user_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"whatsapp_user_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"display_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"whatsapp_user_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"avatar_url": "<string>",
"phone": "<string>",
"email": "<string>",
"whatsapp_user_id": "<string>",
"status": "candidate",
"park_reason": "<string>",
"exit_reason": "<string>",
"fit": 0,
"fit_reason": "<string>",
"batch_key": "<string>",
"source": "<string>",
"next_step_index": 0,
"journey": [
{
"step_index": 0,
"channel": "<string>",
"state": "not_reached",
"at": "2023-11-07T05:31:56Z",
"session_id": "<string>",
"session_ticket_number": 0,
"reason": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"source_detail": "<string>",
"qualification": {
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"judged_at": "2023-11-07T05:31:56Z",
"input_hash": "<string>",
"criteria": {
"must": [
{
"label": "<string>",
"text": "<string>"
}
],
"nice": [
{
"label": "<string>",
"text": "<string>",
"grade": "high"
}
]
},
"verdicts": [
{
"kind": "must",
"label": "<string>",
"text": "<string>",
"verdict": "pass",
"reasoning": "<string>",
"citations": [
{
"enricher": "<string>",
"kind": "<string>",
"id": "<string>"
}
],
"grade": "high"
}
],
"counts": {
"must_total": 0,
"must_passed": 0,
"must_failed": 0,
"must_unsure": 0,
"nice_total": 0,
"nice_weight_total": 0,
"nice_weight_earned": 0,
"nice_unsure": 0
}
},
"enrichment": {},
"next_eligible_at": "2023-11-07T05:31:56Z",
"next_channel": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the sequence
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$The person's contact id (from enroll results or the people list)
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Body
application/json
Response
Default Response
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Available options:
candidate, active, parked, exited, completed Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Was this page helpful?