Organizations

Update current organization account profile

Updates the authenticated user's current organization profile, including contact, settings, and communication configuration.

put/organizations/me

Request

  • Base URL: https://api.leadping.ai
  • URL: https://api.leadping.ai/organizations/me
  • Auth: HTTP bearer

Request body

namestring nullable

Primary organization name.

secondaryNamestring nullable

Alternate organization name or DBA shown in Leadping.

phonestring nullable

Phone details for the lead, user, or organization represented by this organization profile request.

websitestring nullable

Organization website URL used for compliance, brand review, and lead attribution.

verticalstring nullable

Industry vertical used for lead routing, compliance review, and reporting.

descriptionstring nullable

Human-readable description that explains this organization profile request to API users.

einstring nullable

Employer Identification Number used for organization and 10DLC verification.

isYoungerThan90boolean nullable

Whether the organization was formed less than 90 days ago.

offerstring nullable

Main service or offer described during organization setup.

targetAudiencestring nullable

Intended audience described during organization setup.

Response

Returns the organization response.

isDemoboolean
secondaryNamestring nullable

Alternate organization name or DBA shown in Leadping.

accountBalancenumber double

Current wallet balance available to the organization.

billingPlan'Annual' | 'Monthly' nullable

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

subscriptionStatus'Pending' | 'Active' | 'Overdue' | 'Canceled' nullable

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

autoRefillEnabledboolean

Indicates whether automatic wallet refill is enabled for the organization.

autoRefillAmountnumber double nullable

Wallet refill amount charged when automatic refill is triggered.

autoRefillTriggernumber double nullable

Wallet balance threshold that triggers automatic refill.

status'SettingUp' | 'SetupCompleted' | 'Active' nullable

Describes an organization's account lifecycle and whether it can actively use Leadping services.

setupStatus'Personal' | 'Organization' | 'Details' | 'Compliance' | 'Phone' | 'Plan' | 'Billing' | 'Review' | 'Complete' nullable

Describes a user's progress through required Leadping profile and account setup tasks.

enabledboolean

Indicates whether this organization profile response is active and available in the Leadping API.

phonestring nullable

Phone details for the lead, user, or organization represented by this organization profile response.

websitestring nullable

Organization website URL used for compliance, brand review, and lead attribution.

billingNamestring nullable

Name used for invoices, receipts, and payment processor billing records.

billingTaxIdstring nullable

Tax identifier printed on billing documents. This may differ from the organization verification EIN.

verticalstring nullable

Industry vertical used for lead routing, compliance review, and reporting.

descriptionstring nullable

Human-readable description that explains this organization profile response to API users.

einstring nullable

Employer Identification Number used for organization and 10DLC verification.

domainstring nullable

Domain name connected to the organization website or activation workflow.

setupStep'DomainFinding' | 'DomainOptionsFound' | 'SiteGenerating' | 'SiteGenerated' | 'BrandSubmitted' | 'BrandApproved' | 'CampaignSubmitted' | 'CampaignApproved' | 'CarrierReviewing' | 'TenDlcComplete' | 'Complete' nullable

Identifies a discrete billing, telephony, compliance, or configuration stage in organization provisioning.

namestring
idstring
createdAtstring date-time
modifiedAtstring date-time nullable

Changes

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