Alert Contacts
Create a personal alert contact
Create a personal alert contact. Email and push (iOS/Android) are supported; Pro SMS and voice require phone verification and are not creatable here.
post/alert-contacts
Request body
type'Email' | 'ProSms' | 'Voice' | 'MobileAppIOS' | 'MobileAppAndroid' | 'MobileAppOld' | 'MobileApp' required
Personal alert-contact type. Email and mobile push for iOS or Android are creatable here; Pro SMS and voice require phone verification. Use MobileAppIOS or MobileAppAndroid for mobile push. DEPRECATED: MobileAppOld (use MobileAppIOS) and MobileApp (use MobileAppAndroid) are accepted through October 10, 2026 and will be rejected after that date.
friendlyNamestring
Display name of the alert contact
enableNotificationsFor0 | 1 | 2 | 3
valuestring
Email address (required for Email contacts)
deviceNamestring
Device name (push)
oneSignalSubscriptionIdstring
OneSignal subscription ID (push)
oneSignalUserIdstring
OneSignal user ID (push)
deviceFingerprintstring
Device fingerprint (push)
pushTokenstring
Push notification token (push)
platform'ios' | 'android'
Device platform (push)
Response
idnumber required
friendlyNamestring nullable required
{"stackTrail":"components:schemas:AlertContactDto:properties:type","oasType":"schema","type":"unknown","description":"Alert-contact type. Mobile push responses retain MobileAppOld (iOS) and MobileApp (Android) through October 10, 2026; consumers should also accept MobileAppIOS and MobileAppAndroid before responses switch to those canonical names after the deadline."}
valuestring nullable required
customValuestring nullable required
{"stackTrail":"components:schemas:AlertContactDto:properties:enableNotificationsFor","oasType":"schema","type":"unknown"}
sslExpirationReminderboolean nullable required
httpUsernamestring nullable required
httpPasswordstring nullable required
authTypeboolean nullable required
customHeadersobject nullable
mobileProviderIdnumber nullable required
{"stackTrail":"components:schemas:AlertContactDto:properties:status","oasType":"schema","type":"unknown"}
orgAlertContactIdnumber nullable required