> ## Documentation Index
> Fetch the complete documentation index at: https://thehyperstack.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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

<ParamField header="Authorization" type="string" required="true">
  Bearer YOUR\_API\_TOKEN — obtainable from **Hyperstack Dashboard → Settings → API Access**
</ParamField>

### Body Parameters

<ParamField body="email" type="string" required="true">
  The email address of the recipient to update.
</ParamField>

<ParamField body="custom_attributes" type="object" required="false">
  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.
</ParamField>

### Success Response Fields

<ResponseField name="success" type="boolean">
  Indicates whether the recipient was successfully updated.
</ResponseField>

<ResponseField name="message" type="string">
  A confirmation message. Value: `"Recipient details updated successfully"`.
</ResponseField>

### Responses

<ResponseExample>
  ```json 200 Success theme={null}
  {
    "success": true,
    "message": "Recipient details updated successfully"
  }
  ```

  ```json 200 Not Found theme={null}
  {
    "success": false,
    "error": "Recipient Not Found",
    "error_code": "recipient_not_found"
  }
  ```

  ```json 401 Unauthorized theme={null}
  {
    "detail": "Invalid token or organization not found"
  }
  ```
</ResponseExample>

```bash theme={null}
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"
    }
  }'
```