Skip to main content
POST
/
v1
/
recipients
/
update
Update Recipient
curl --request POST \
  --url https://api.thehyperstack.com/v1/recipients/update \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "custom_attributes": {}
}
'
{
  "success": true,
  "message": "Recipient details updated successfully"
}

​
Description

This endpoint allows you to update custom attribute data for an existing recipient in your organization. Only custom fields defined for recipients in your account (prefixed with custom_) will be updated.

​
Headers

​
Authorization
string
required
Bearer YOUR_API_TOKEN — obtainable from Hyperstack Dashboard → Settings → API Access

​
Body Parameters

​
email
string
required
The email address of the recipient to update.
​
custom_attributes
object
required
Key-value pairs of custom attributes to update on the recipient. Keys must match the custom recipient fields (prefixed with custom_) configured for your account.

​
Success Response Fields

​
success
boolean
Indicates whether the recipient was successfully updated.
​
message
string
A confirmation message. Value: "Recipient details updated successfully".

​
Responses

{
  "success": true,
  "message": "Recipient details updated successfully"
}

curl -X POST "https://api.thehyperstack.com/v1/recipients/update" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john@example.com",
    "custom_attributes": {
      "custom_department": "Engineering",
      "custom_location": "New York"
    }
  }'
Last modified on February 22, 2026