Skip to main content
PUT
Updates the current user's notification preferences without requiring profile fields.

Authorizations

Authorization
string
header
required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Body

The notification preferences to store for the current user.

Describes user notification preferences data used in Leadping API requests and responses.

Whether the user has consented to receive Leadping account notification SMS messages.

When the user's Leadping notification SMS consent was last changed.

The TrustedForm certificate captured for the user's most recent SMS opt-in.

paymentFailedEnabled
boolean

Whether payment failed notifications are enabled for this user notification preferences.

paymentFailedSmsEnabled
boolean

Indicates whether payment failed SMS functionality is enabled for this Leadping user notification preferences.

lowWalletBalanceEnabled
boolean

Whether low wallet balance notifications are enabled for this user notification preferences.

lowWalletBalanceEmailEnabled
boolean

Indicates whether low wallet balance email functionality is enabled for this Leadping user notification preferences.

lowWalletBalanceSmsEnabled
boolean

Indicates whether low wallet balance SMS functionality is enabled for this Leadping user notification preferences.

tenDlcStatusEnabled
boolean

Whether 10DLC status notifications are enabled for this user notification preferences.

newLeadEnabled
boolean

Whether new lead notifications are enabled for this user notification preferences.

newLeadEmailEnabled
boolean

Whether new lead email is enabled for this user notification preferences.

newLeadSmsEnabled
boolean

Whether new lead SMS is enabled for this user notification preferences.

missedCallEnabled
boolean

Whether missed call notifications are enabled for this user notification preferences.

missedCallEmailEnabled
boolean

Indicates whether missed call email functionality is enabled for this Leadping user notification preferences.

missedCallSmsEnabled
boolean

Indicates whether missed call SMS functionality is enabled for this Leadping user notification preferences.

unreadSmsEnabled
boolean

Whether unread SMS notifications are enabled for this user notification preferences.

unreadSmsEmailEnabled
boolean

Indicates whether unread SMS email functionality is enabled for this Leadping user notification preferences.

unreadSmsSmsEnabled
boolean

Indicates whether unread SMS SMS functionality is enabled for this Leadping user notification preferences.

automationFailedEnabled
boolean

Whether automation failed notifications are enabled for this user notification preferences.

automationFailedEmailEnabled
boolean

Indicates whether automation failed email functionality is enabled for this Leadping user notification preferences.

automationFailedSmsEnabled
boolean

Indicates whether automation failed SMS functionality is enabled for this Leadping user notification preferences.

billingEmailEnabled
boolean

Whether billing email is enabled for this user notification preferences.

billingSmsEnabled
boolean

Whether billing SMS is enabled for this user notification preferences.

subscriptionRenewingEnabled
boolean

Whether subscription renewing notifications are enabled for this user notification preferences.

subscriptionRenewingEmailEnabled
boolean

Indicates whether subscription renewing email functionality is enabled for this Leadping user notification preferences.

subscriptionRenewingSmsEnabled
boolean

Indicates whether subscription renewing SMS functionality is enabled for this Leadping user notification preferences.

usageLimitHitEnabled
boolean

Whether usage limit hit notifications are enabled for this user notification preferences.

Response

OK

Describes user data returned by Leadping.

email
string<email>

The email address associated with this user.

firstName
null | string

First name for this user.

lastName
null | string

Last name of the Leadping user.

phone
null | string

The phone number associated with this user.

timeZoneId
null | string

IANA time zone identifier used when displaying dates and times for this user.

billingPlan
null | enum<string>

Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.

Available options:
Annual,
Monthly
subscriptionStatus
null | enum<string>

Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states.

Available options:
Pending,
Active,
Overdue,
Canceled
billingState
object | null

Customer-safe billing state for the user's currently selected organization.

roles
null | string[]

The roles included with this user.

A Leadping user role value.

identities
null | object[]

The identities included with this user.

currentOrganization
object | null

Current organization for this user.

compliance
object | null

Compliance for this user.

notificationPreferences
object | null

Notification preferences for this user.

mobileDevicePreferences
null | object[]

The Leadping mobile device preferences for this user.

lastLoggedInAt
null | string<date-time>

The date and time when this user last completed the Leadping sign-in flow.

personalDataDeletionRequestedAt
null | string<date-time>

UTC timestamp for personal data deletion requested at on this user.

personalDataDeletedAt
null | string<date-time>

UTC timestamp for personal data deleted at on this user.

personalDataDeletionStatus
null | string

The current personal data deletion status for this user.

personalDataDeletionReason
null | string

The human-readable personal data deletion reason explaining this user.

name
string

Human-readable display name of the resource.

id
string

Stable unique identifier of the resource.

createdAt
string<date-time>

UTC timestamp when the resource was created.

modifiedAt
null | string<date-time>

UTC timestamp when the resource was last modified, or null when it has not been updated.