---
title: "Update Recipient Route"
method: PUT
path: "/admin/notifications/recipients/{recipient_id}"
tags: ["admin", "recipients"]
---

# Update Recipient Route

`PUT /admin/notifications/recipients/{recipient_id}`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/admin/notifications/recipients/{recipient_id}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Path parameters

- `recipient_id` string, required

## Headers

- `organization-id` string, nullable
- `timezone` string
- `x-user-id` string, nullable
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Request body

- RecipientInput
  - `organization_id` string, required
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `deleted_at` string, date-time, nullable
  - `id` string
  - `user_id` string, nullable, required
  - `name` string, nullable, required
  - `email` string, nullable, required
  - `phone` string, nullable, required
  - `type` 'user' | 'entity' | 'technician', required: What kind of destination a recipient is. ENTITY is a mailing list (info@company.com), which is why entity recipients take email and never SMS — unless the row is bound to a user, in which case its phone is that person's own. TECHNICIAN is a person the platform resolved from ServiceTitan rather than an UpSmith user — reachable on their own phone, so SMS eligibility follows from the type rather than a carve-out.
  - `source` 'st_technician' | 'onboarding' | 'web_callback': Who provisioned this recipient. NULL — not a member of this enum — means a human added it in the notifications settings UI. Every value here is a row the platform created for itself, resolved per event rather than named by somebody.
  - `source_ref` string, nullable
  - `active` boolean
  - `email_enabled` boolean, nullable
  - `sms_enabled` boolean, nullable
  - `call_enabled` boolean, nullable
  - `channel_preference` 'email' | 'sms' | 'app' | 'push' | 'call'
  - `batch_cron_string` string
  - `batch_priority_threshold` integer
  - `next_batch_at` string, date-time, nullable, required

## Response `200`

Successful Response

- RecipientOutput

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/cce8b07a5787?raw)