Create Recipient Route

post/admin/notifications/recipients/

Request

Base URL
https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
Auth
- API key in header x-api-key
- or HTTP bearer

Headers

organization-idstring nullable

timezonestring

x-user-idstring nullable

x-actor-emailstring nullable

x-request-sourcestring nullable

x-operation-idstring nullable

x-commit-messagestring nullable

x-confirmation-idstring nullable

x-chat-idstring nullable

Request body

organization_idstring required

created_atstring date-time

updated_atstring date-time

deleted_atstring date-time nullable

idstring

user_idstring nullable required

namestring nullable required

emailstring nullable required

phonestring 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_refstring nullable

activeboolean

email_enabledboolean nullable

sms_enabledboolean nullable

call_enabledboolean nullable

channel_preference'email' | 'sms' | 'app' | 'push' | 'call'

batch_cron_stringstring

batch_priority_thresholdinteger

next_batch_atstring date-time nullable required

Response

Successful Response

RecipientOutput required

Changes

No recorded changes to this operation across all 1 revision of this API.