Update Recipient
curl --request POST \
--url https://api.thehyperstack.com/v1/recipients/update \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"custom_attributes": {}
}
'import requests
url = "https://api.thehyperstack.com/v1/recipients/update"
payload = {
"email": "<string>",
"custom_attributes": {}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '<string>', custom_attributes: {}})
};
fetch('https://api.thehyperstack.com/v1/recipients/update', 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.thehyperstack.com/v1/recipients/update",
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([
'email' => '<string>',
'custom_attributes' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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.thehyperstack.com/v1/recipients/update"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"custom_attributes\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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://api.thehyperstack.com/v1/recipients/update")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"custom_attributes\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.thehyperstack.com/v1/recipients/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"custom_attributes\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Recipient details updated successfully"
}
{
"success": false,
"error": "Recipient Not Found",
"error_code": "recipient_not_found"
}
{
"success": false,
"error": "custom_attributes must be an object of attribute names and values",
"error_code": "invalid_custom_attributes"
}
{
"detail": "Invalid token or organization not found"
}
Recipients
Update Recipient
POST
/
v1
/
recipients
/
update
Update Recipient
curl --request POST \
--url https://api.thehyperstack.com/v1/recipients/update \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"custom_attributes": {}
}
'import requests
url = "https://api.thehyperstack.com/v1/recipients/update"
payload = {
"email": "<string>",
"custom_attributes": {}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '<string>', custom_attributes: {}})
};
fetch('https://api.thehyperstack.com/v1/recipients/update', 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.thehyperstack.com/v1/recipients/update",
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([
'email' => '<string>',
'custom_attributes' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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.thehyperstack.com/v1/recipients/update"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"custom_attributes\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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://api.thehyperstack.com/v1/recipients/update")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"custom_attributes\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.thehyperstack.com/v1/recipients/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"custom_attributes\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Recipient details updated successfully"
}
{
"success": false,
"error": "Recipient Not Found",
"error_code": "recipient_not_found"
}
{
"success": false,
"error": "custom_attributes must be an object of attribute names and values",
"error_code": "invalid_custom_attributes"
}
{
"detail": "Invalid token or organization not found"
}
Description
Sets custom attribute values on a recipient. A recipient keeps these values across all their credentials. A recipient exists in your organization once a credential has been published to their email. Only the attributes you send are changed.Headers
string
required
Your API key:
Bearer YOUR_API_KEY. Create a key in the Studio under Settings → Developers.Body Parameters
string
required
Email address of the recipient.
object
Values to set, such as
{"custom_department": "Engineering"}. Each key is the merge tag of an attribute, without brackets. You find them in the Studio under Settings → Attributes.Only attributes whose value belongs to Each recipient are saved. Other keys are ignored. Values are saved as text.If custom_attributes is not an object, the call returns 400 with invalid_custom_attributes, and nothing is changed.Success Response Fields
boolean
true when the recipient was updated.string
Always
"Recipient details updated successfully".Responses
When no recipient has this email, the status is still200. Check success.
{
"success": true,
"message": "Recipient details updated successfully"
}
{
"success": false,
"error": "Recipient Not Found",
"error_code": "recipient_not_found"
}
{
"success": false,
"error": "custom_attributes must be an object of attribute names and values",
"error_code": "invalid_custom_attributes"
}
{
"detail": "Invalid token or organization not found"
}
curl -X POST "https://api.thehyperstack.com/v1/recipients/update" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "jane.doe@example.com",
"custom_attributes": {
"custom_department": "Engineering",
"custom_employee_id": "ACME-10442"
}
}'
Last modified on October 20, 2026
Was this page helpful?