v4

latestOpenAPI 3.0.02026-08-0559120263.4 KB

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

type'Email' | 'ProSms' | 'Voice' | 'MobileAppOld' | 'MobileApp' required

Personal alert-contact type. Email and push (MobileAppOld/MobileApp) are creatable here; Pro SMS and voice require phone verification.

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)

idnumber required

friendlyNamestring nullable required

{"stackTrail":"components:schemas:AlertContactDto:properties:type","oasType":"schema","type":"unknown"}

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