> ## Documentation Index > Fetch the complete documentation index at: https://leadping.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Updates the current user's notification preferences without requiring profile fields. > Replaces the notification channel and delivery preferences stored for the authenticated user. ## OpenAPI ````yaml /openapi.json put /users/me/notification-preferences openapi: 3.1.1 info: title: Leadping API description: >- The Leadping API helps businesses capture and manage leads, automate follow-up, send SMS and MMS messages, place calls, track conversations, enforce contact suppression, and analyze communication workflows. Use this OpenAPI 3.1 contract to integrate lead sources, build organization tools, or generate a typed API client. Authenticate protected operations with a Leadping user access token or WorkOS organization API key. Lead intake operations also accept a Leadping source key. termsOfService: https://leadping.ai/docs/terms-of-service contact: name: Leadping Support url: https://leadping.ai/contact email: support@leadping.ai license: name: MIT url: https://opensource.org/licenses/MIT version: v1 summary: Lead management, messaging, calling, and automation API servers: - url: https://api.leadping.ai description: Production security: [] tags: - name: leadping.Api description: >- Agent-to-agent discovery and request handling for Leadping's supported AI agent integrations. - name: Analytics description: >- Provides lead, communication, conversion, and organization performance analytics. Use these endpoints to measure activity over time, compare outcomes, and power operational dashboards and reporting workflows. - name: Automations description: >- Manages automated lead follow-up workflows and their execution history. Use these endpoints to configure SMS automation steps, preview eligible leads, run workflows, and inspect individual automation executions. - name: BlogArticles description: >- Provides published Leadping blog content. Use these endpoints to list published articles and retrieve an individual article by its public slug. - name: Conversations description: >- Provides lead conversation timelines and inbox-oriented conversation views. Use these endpoints to list recent conversations and retrieve the cross-channel communication history associated with a lead. - name: Feedback description: >- Captures Leadping product feedback and supports administrative triage. Users can submit feedback, while authorized staff can search, inspect, classify, and update feedback throughout the review process. - name: Leads description: >- Manages lead intake, records, assignment, routing, and lifecycle operations. Use these endpoints to ingest leads from trusted sources, search and update lead records, manage ownership and tags, and archive or delete leads. - name: LeadStatusChanges description: >- Manages the auditable history of lead status transitions. Use these endpoints to change a lead's status, correct transition records, search status history, and export status activity for reporting. - name: LeadStatuses description: >- Manages the lead statuses used to classify and track leads throughout their lifecycle. Use these endpoints to list, create, update, and archive organization-specific lead statuses for consistent pipeline organization and reporting. - name: Notifications description: >- Manages user notifications, announcements, and push-notification installations. Use these endpoints to retrieve notification feeds and unread counts, update read state, and register or remove client push installations. - name: OutboundDelivery description: >- Reports outbound delivery pacing and sending capacity for the current organization. Use these endpoints to determine whether outbound communications can proceed and to understand active throttles, limits, or capacity constraints. - name: Sources description: >- Manages lead sources, intake credentials, routing defaults, and attribution. Use these endpoints to create and configure sources, search source records, inspect source activity, rotate intake access, and remove obsolete sources. - name: Suppressions description: >- Manages recipient suppression state for compliant Leadping communication workflows. Use these endpoints to check contact eligibility, record or release suppressions, and review suppression history before sending messages or placing calls. - name: Tags description: >- Manages organization-defined tags for categorizing and routing leads. Use these endpoints to list, create, update, and archive reusable tags that support lead filtering, automation, assignment, and reporting. - name: Users description: >- Manages the current Leadping user's profile, preferences, setup, and account workflows. Use these endpoints to retrieve and update user data, configure communication and compliance preferences, complete onboarding, manage plan-related actions, and request account operations. - name: Calls description: >- Manages outbound Leadping calls and active call-control workflows. Use these endpoints to initiate or cancel a call, retrieve call state, and transfer an active call within supported telephony flows. - name: PhoneNumbers description: >- Manages phone-number discovery, purchasing, assignment, configuration, and compliance. Use these endpoints to search available numbers, manage owned numbers and caller identity, configure messaging or voice behavior, and monitor registration and warmup state. - name: Sms description: >- Sends and manages SMS and MMS communications through Leadping. Use these endpoints to send messages, upload MMS media, and cancel eligible scheduled messages while preserving conversation and delivery tracking. - name: Telephony description: >- Provides shared authentication and bootstrap data for Leadping telephony clients. Use this endpoint to obtain the scoped credentials and configuration required to initialize supported calling experiences. - name: Organizations description: >- Manages Leadping organizations, memberships, invitations, settings, and API credentials. Use these endpoints to maintain organization profiles and branding, manage members and invitations, configure options, and issue or revoke organization API keys. - name: UserDataExports description: >- Creates and delivers user-requested exports of Leadping account data. Use these endpoints to request an export, monitor its preparation status, and download the completed archive through a time-limited redirect. - name: CallEvents description: >- Provides call event records for auditing, diagnostics, and reporting. Use these endpoints to search and inspect lifecycle events emitted as Leadping calls are initiated, connected, completed, or fail. - name: Events description: >- Provides a unified record of Leadping activity across communication channels. Use these endpoints to retrieve event timelines, search event history, inspect event details, and record supported application events. - name: SmsEvents description: >- Provides SMS and MMS event records for delivery tracking and diagnostics. Use these endpoints to search and inspect message lifecycle events, including outbound delivery updates and inbound messaging activity. - name: PaymentMethods description: >- Manages organization payment methods and billing invoices. Use these endpoints to add, confirm, inspect, and remove payment methods or retrieve invoices associated with the current organization's billing account. - name: Transactions description: >- Provides organization wallet and billing transaction records. Use these endpoints to search transaction history, inspect individual charges or credits, review transaction summaries, and issue administrative credits. - name: Usage description: >- Provides billable usage records for Leadping services. Use these endpoints to review messaging and calling consumption, inspect usage summaries, and reconcile provider activity for an organization. - name: Wallets description: >- Manages organization wallet balances, funding, and credit activity. Use these endpoints to inspect wallet state and history, configure wallet behavior, add funds, and record credits or adjustments. externalDocs: description: >- Leadping API documentation, authentication guide, concepts, and integration guidance. url: https://leadping.ai/docs/api-reference paths: /users/me/notification-preferences: put: tags: - Users summary: >- Updates the current user's notification preferences without requiring profile fields. description: >- Replaces the notification channel and delivery preferences stored for the authenticated user. operationId: Users_UpdateNotificationPreferencesForCurrentUser requestBody: description: The notification preferences to store for the current user. content: application/json: schema: allOf: - $ref: '#/components/schemas/UserNotificationPreferences' description: >- Describes user notification preferences data used in Leadping API requests and responses. application/*+json: schema: allOf: - $ref: '#/components/schemas/UserNotificationPreferences' description: >- Describes user notification preferences data used in Leadping API requests and responses. required: true responses: '200': description: OK content: application/json: schema: allOf: - $ref: '#/components/schemas/UserResponse' description: Describes user data returned by Leadping. '400': description: The request was invalid or failed validation. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Bad Request status: 400 detail: The request could not be completed. '401': description: Authentication credentials are missing or invalid. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Unauthorized status: 401 detail: The request could not be completed. '429': description: The API rate limit for this account or client has been exceeded. headers: Retry-After: description: Number of seconds to wait before retrying the request. schema: minimum: 0 type: integer format: int32 content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Too Many Requests status: 429 detail: The request could not be completed. security: - Bearer: [] components: schemas: UserNotificationPreferences: type: object properties: smsConsentOptedIn: type: - 'null' - boolean description: >- Whether the user has consented to receive Leadping account notification SMS messages. smsConsentUpdatedAt: type: - 'null' - string description: When the user's Leadping notification SMS consent was last changed. format: date-time smsConsentTrustedFormCertificate: type: - 'null' - object allOf: - $ref: '#/components/schemas/TrustedFormCertificate' description: >- The TrustedForm certificate captured for the user's most recent SMS opt-in. paymentFailedEnabled: type: boolean description: >- Whether payment failed notifications are enabled for this user notification preferences. paymentFailedSmsEnabled: type: boolean description: >- Indicates whether payment failed SMS functionality is enabled for this Leadping user notification preferences. lowWalletBalanceEnabled: type: boolean description: >- Whether low wallet balance notifications are enabled for this user notification preferences. lowWalletBalanceEmailEnabled: type: boolean description: >- Indicates whether low wallet balance email functionality is enabled for this Leadping user notification preferences. lowWalletBalanceSmsEnabled: type: boolean description: >- Indicates whether low wallet balance SMS functionality is enabled for this Leadping user notification preferences. tenDlcStatusEnabled: type: boolean description: >- Whether 10DLC status notifications are enabled for this user notification preferences. newLeadEnabled: type: boolean description: >- Whether new lead notifications are enabled for this user notification preferences. newLeadEmailEnabled: type: boolean description: >- Whether new lead email is enabled for this user notification preferences. newLeadSmsEnabled: type: boolean description: >- Whether new lead SMS is enabled for this user notification preferences. missedCallEnabled: type: boolean description: >- Whether missed call notifications are enabled for this user notification preferences. missedCallEmailEnabled: type: boolean description: >- Indicates whether missed call email functionality is enabled for this Leadping user notification preferences. missedCallSmsEnabled: type: boolean description: >- Indicates whether missed call SMS functionality is enabled for this Leadping user notification preferences. unreadSmsEnabled: type: boolean description: >- Whether unread SMS notifications are enabled for this user notification preferences. unreadSmsEmailEnabled: type: boolean description: >- Indicates whether unread SMS email functionality is enabled for this Leadping user notification preferences. unreadSmsSmsEnabled: type: boolean description: >- Indicates whether unread SMS SMS functionality is enabled for this Leadping user notification preferences. automationFailedEnabled: type: boolean description: >- Whether automation failed notifications are enabled for this user notification preferences. automationFailedEmailEnabled: type: boolean description: >- Indicates whether automation failed email functionality is enabled for this Leadping user notification preferences. automationFailedSmsEnabled: type: boolean description: >- Indicates whether automation failed SMS functionality is enabled for this Leadping user notification preferences. billingEmailEnabled: type: boolean description: >- Whether billing email is enabled for this user notification preferences. billingSmsEnabled: type: boolean description: >- Whether billing SMS is enabled for this user notification preferences. subscriptionRenewingEnabled: type: boolean description: >- Whether subscription renewing notifications are enabled for this user notification preferences. subscriptionRenewingEmailEnabled: type: boolean description: >- Indicates whether subscription renewing email functionality is enabled for this Leadping user notification preferences. subscriptionRenewingSmsEnabled: type: boolean description: >- Indicates whether subscription renewing SMS functionality is enabled for this Leadping user notification preferences. usageLimitHitEnabled: type: boolean description: >- Whether usage limit hit notifications are enabled for this user notification preferences. description: >- Describes user notification preferences data used in Leadping API requests and responses. UserResponse: type: object properties: email: type: string description: The email address associated with this user. format: email firstName: type: - 'null' - string description: First name for this user. lastName: type: - 'null' - string description: Last name of the Leadping user. phone: type: - 'null' - string description: The phone number associated with this user. timeZoneId: type: - 'null' - string description: >- IANA time zone identifier used when displaying dates and times for this user. billingPlan: enum: - Annual - Monthly type: - 'null' - string description: >- Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior. subscriptionStatus: enum: - Pending - Active - Overdue - Canceled type: - 'null' - string description: >- Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states. billingState: type: - 'null' - object allOf: - $ref: '#/components/schemas/OrganizationBillingState' description: >- Customer-safe billing state for the user's currently selected organization. roles: type: - 'null' - array items: type: string description: A Leadping user role value. description: The roles included with this user. identities: type: - 'null' - array items: allOf: - $ref: '#/components/schemas/UserIdentity' description: >- Identifies an external sign-in identity linked to a Leadping user, including its provider, provider-assigned user identifier, and authentication method. description: The identities included with this user. currentOrganization: type: - 'null' - object allOf: - $ref: '#/components/schemas/IdNamePair' description: Current organization for this user. compliance: type: - 'null' - object allOf: - $ref: '#/components/schemas/UserCompliance' description: Compliance for this user. notificationPreferences: type: - 'null' - object allOf: - $ref: '#/components/schemas/UserNotificationPreferences' description: Notification preferences for this user. mobileDevicePreferences: type: - 'null' - array items: allOf: - $ref: '#/components/schemas/MobileDevicePreferences' description: >- Describes notification and calling preferences saved for one of the user's mobile devices. description: The Leadping mobile device preferences for this user. lastLoggedInAt: type: - 'null' - string description: >- The date and time when this user last completed the Leadping sign-in flow. format: date-time personalDataDeletionRequestedAt: type: - 'null' - string description: UTC timestamp for personal data deletion requested at on this user. format: date-time personalDataDeletedAt: type: - 'null' - string description: UTC timestamp for personal data deleted at on this user. format: date-time personalDataDeletionStatus: type: - 'null' - string description: The current personal data deletion status for this user. personalDataDeletionReason: type: - 'null' - string description: >- The human-readable personal data deletion reason explaining this user. name: type: string description: Human-readable display name of the resource. id: type: string description: Stable unique identifier of the resource. createdAt: type: string description: UTC timestamp when the resource was created. format: date-time modifiedAt: type: - 'null' - string description: >- UTC timestamp when the resource was last modified, or null when it has not been updated. format: date-time description: Describes user data returned by Leadping. ProblemDetails: type: object properties: type: type: - 'null' - string description: URI reference that identifies the problem type. title: type: - 'null' - string description: Short, human-readable summary of the problem. status: type: - 'null' - integer description: HTTP status code returned for the problem. format: int32 detail: type: - 'null' - string description: >- Human-readable explanation specific to this occurrence of the problem. instance: type: - 'null' - string description: >- URI reference that identifies this specific occurrence of the problem. errors: type: object additionalProperties: type: array items: type: string description: >- Validation errors keyed by the JSON request field name. Present for request validation failures. traceId: type: string description: >- Request trace identifier used to correlate this problem with Leadping diagnostics. description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. TrustedFormCertificate: type: object properties: id: type: - 'null' - string description: Unique Leadping identifier for this TrustedForm certificate. url: type: string description: The URL associated with this TrustedForm certificate. format: uri source: type: - 'null' - string description: Source for this TrustedForm certificate. createdAt: type: - 'null' - string description: UTC timestamp for created at on this TrustedForm certificate. format: date-time description: >- Describes trusted form certificate data used in Leadping API requests and responses. OrganizationBillingState: type: object properties: hasStripeCustomer: type: boolean description: Indicates whether the organization has a Stripe customer account. hasPaymentMethod: type: boolean description: >- Indicates whether the organization has a saved default payment method. phoneNumberQuantity: type: - 'null' - integer description: >- Number of phone numbers included in the organization's subscription plan. format: int64 organizationMemberQuantity: type: - 'null' - integer description: >- Number of user licenses included in the organization's subscription plan. format: int64 organizationMemberAssignedQuantity: type: - 'null' - integer description: Number of user licenses currently assigned to organization members. format: int64 pendingBillingPlan: enum: - Annual - Monthly type: - 'null' - string description: >- Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior. billingPlanChangeEffectiveAt: type: - 'null' - string description: Date and time when the scheduled billing plan change takes effect. format: date-time planRenewalAt: type: - 'null' - string description: Current plan renewal date. format: date-time planPeriodStartAt: type: - 'null' - string description: Start of the current plan billing period. format: date-time cancelAt: type: - 'null' - string description: UTC timestamp when the active subscription is scheduled to cancel. format: date-time dunning: type: - 'null' - object allOf: - $ref: '#/components/schemas/OrganizationDunningInfo' description: Customer-safe payment recovery state for the organization. lastSubscriptionEventAt: type: - 'null' - string description: >- UTC timestamp when Leadping last processed a subscription event for the organization. format: date-time lastPaymentMethodEventAt: type: - 'null' - string description: >- UTC timestamp when Leadping last processed a payment-method event for the organization. format: date-time description: Customer-safe billing state for a Leadping organization. UserIdentity: type: object properties: issuer: type: string description: >- Identity provider or tenant that issued the sign-in identity, such as contoso.com or facebook.com. issuerAssignedId: type: string description: >- Stable unique user identifier assigned by the identity provider within the issuer's namespace. signInType: type: string description: >- Sign-in method represented by the identity, such as emailAddress, userName, or federated. description: >- Identifies an external sign-in identity linked to a Leadping user, including its provider, provider-assigned user identifier, and authentication method. IdNamePair: required: - id - name type: object properties: id: type: string description: Stable unique identifier of the referenced resource. name: type: string description: Human-readable display name of the referenced resource. description: >- Provides a compact API reference to another resource using its stable identifier and human-readable display name. UserCompliance: type: object properties: acceptedTerms: type: boolean description: Whether the user accepted terms for this user compliance. acceptedToSubscription: type: boolean description: Whether the user accepted subscription for this user compliance. acceptedSms: type: boolean description: Whether the user accepted SMS for this user compliance. acceptedBaa: type: boolean description: Whether the user accepted BAA for this user compliance. acceptedEmail: type: boolean description: Whether the user accepted email for this user compliance. trustedFormCertificates: type: - 'null' - array items: allOf: - $ref: '#/components/schemas/TrustedFormCertificate' description: >- Describes trusted form certificate data used in Leadping API requests and responses. description: The TrustedForm certificates included with this user compliance. description: >- Describes user compliance data used in Leadping API requests and responses. MobileDevicePreferences: type: object properties: device: allOf: - $ref: '#/components/schemas/IdNamePair' description: Identifier and display name of the related device. inboundPhoneCallsEnabled: type: boolean description: Whether inbound phone calls are enabled for this user device. updatedAt: type: - 'null' - string description: The date and time this device preference was last updated. format: date-time description: >- Describes notification and calling preferences saved for one of the user's mobile devices. OrganizationDunningInfo: type: object properties: stage: type: - 'null' - string description: Current stage for this Leadping organization dunning info. paymentFailedAt: type: - 'null' - string description: >- Date and time when this Leadping organization dunning info was payment failed. format: date-time lastFailedInvoiceStatus: type: - 'null' - string description: >- Current last failed invoice status for this Leadping organization dunning info. retryAttemptCount: type: integer description: >- Total number of retry attempt records represented by this Leadping organization dunning info. format: int32 nextRetryAt: type: - 'null' - string description: Date and time when the next retry is scheduled. format: date-time gracePeriodEndsAt: type: - 'null' - string description: >- Date and time when this Leadping organization dunning info was grace period ends. format: date-time outboundRestrictedAt: type: - 'null' - string description: >- Date and time when this Leadping organization dunning info was outbound restricted. format: date-time outboundSuspendedAt: type: - 'null' - string description: >- Date and time when this Leadping organization dunning info was outbound suspended. format: date-time finalCancellationAt: type: - 'null' - string description: >- Date and time when this Leadping organization dunning info was final cancellation. format: date-time lastUpdatedAt: type: - 'null' - string description: >- Date and time when this Leadping organization dunning info was last updated. format: date-time description: Dunning state recorded after a failed recurring payment. securitySchemes: Bearer: type: http description: >- Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_. scheme: bearer bearerFormat: JWT or organization API key ````