Skip to main content
POST
Update Recipient

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

Last modified on February 22, 2026