Skip to main content
PUT
/
businesses
/
me
Update current business account profile
curl --request PUT \
  --url https://api.leadping.ai/businesses/me \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "secondaryName": "<string>",
  "enabled": true,
  "adminEnablementOverride": {
    "enabled": true,
    "reason": "<string>",
    "updatedByUserId": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "autoRefillEnabled": true,
  "autoRefillAmount": "<string>",
  "autoRefillTrigger": "<string>",
  "phone": "<string>",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "province": "<string>",
    "region": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "additionalInfo": "<string>"
  },
  "website": "<string>",
  "vertical": "<string>",
  "description": "<string>",
  "ein": "<string>",
  "isYoungerThan90": true,
  "phones": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "activation": {
    "controlledLaunch": true,
    "customerFacingStatus": "<string>",
    "paymentMethodConfirmedAt": "2023-11-07T05:31:56Z",
    "subscriptionPendingAt": "2023-11-07T05:31:56Z",
    "subscriptionActiveAt": "2023-11-07T05:31:56Z",
    "launchReviewRequestedAt": "2023-11-07T05:31:56Z",
    "launchApprovedAt": "2023-11-07T05:31:56Z",
    "telephonyProvisioningStartedAt": "2023-11-07T05:31:56Z",
    "telephonyPartiallyProvisionedAt": "2023-11-07T05:31:56Z",
    "telephonyReadyAt": "2023-11-07T05:31:56Z",
    "failedAt": "2023-11-07T05:31:56Z",
    "activatedAt": "2023-11-07T05:31:56Z",
    "industry": "<string>",
    "businessDescription": "<string>",
    "targetAudience": "<string>",
    "offer": "<string>",
    "websiteNeeds": "<string>",
    "serviceArea": "<string>",
    "complianceNotes": "<string>",
    "domainOptions": [
      {
        "domainName": "<string>",
        "whyItFits": "<string>",
        "industryRelevance": "<string>",
        "trustConcerns": "<string>",
        "estimatedAnnualCost": "<string>",
        "availabilityStatus": "<string>",
        "recommended": true
      }
    ],
    "selectedDomain": "<string>",
    "domainApprovedAt": "2023-11-07T05:31:56Z",
    "websiteUrl": "<string>",
    "tenDlcDraft": {
      "companyName": "<string>",
      "contactName": "<string>",
      "contactEmail": "<string>",
      "contactPhone": "<string>",
      "ein": "<string>",
      "websiteUrl": "<string>",
      "industry": "<string>",
      "useCase": "<string>",
      "useCaseDescription": "<string>",
      "messageExamples": [
        "<string>"
      ],
      "optInLanguage": "<string>",
      "privacyPolicyUrl": "<string>",
      "termsUrl": "<string>",
      "expectedMonthlyVolume": "<string>",
      "leadSource": "<string>",
      "trustedFormRequired": true,
      "complianceWarnings": [
        "<string>"
      ],
      "missingFields": [
        "<string>"
      ],
      "lastSubmittedAt": "2023-11-07T05:31:56Z",
      "rejectionReason": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "version": "<string>"
    },
    "events": [
      {
        "id": "<string>",
        "type": "<string>",
        "title": "<string>",
        "details": "<string>",
        "status": "<string>",
        "actorName": "<string>",
        "failureReason": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "compliancePolicy": {
    "enabled": true,
    "allowedStates": [
      "<string>"
    ],
    "allowedProducts": [
      "<string>"
    ],
    "requireLeadState": true,
    "requireAgentLicenseState": true,
    "requireProduct": true,
    "requireTrustedFormForAutomations": true,
    "requireSourceComplianceApproval": true
  },
  "id": "<string>"
}
'
{
  "secondaryName": "<string>",
  "user": {
    "id": "<string>",
    "name": "<string>"
  },
  "accountBalance": "<string>",
  "autoRefillEnabled": true,
  "autoRefillAmount": "<string>",
  "autoRefillTrigger": "<string>",
  "enabled": true,
  "adminEnablementOverride": {
    "enabled": true,
    "reason": "<string>",
    "updatedByUserId": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "phone": "<string>",
  "website": "<string>",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "province": "<string>",
    "region": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "additionalInfo": "<string>"
  },
  "vertical": "<string>",
  "description": "<string>",
  "ein": "<string>",
  "einDocument": {
    "id": "<string>",
    "name": "<string>",
    "value": "<string>"
  },
  "domain": "<string>",
  "phones": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "site": {
    "id": "<string>",
    "name": "<string>"
  },
  "activation": {
    "controlledLaunch": true,
    "customerFacingStatus": "<string>",
    "paymentMethodConfirmedAt": "2023-11-07T05:31:56Z",
    "subscriptionPendingAt": "2023-11-07T05:31:56Z",
    "subscriptionActiveAt": "2023-11-07T05:31:56Z",
    "launchReviewRequestedAt": "2023-11-07T05:31:56Z",
    "launchApprovedAt": "2023-11-07T05:31:56Z",
    "telephonyProvisioningStartedAt": "2023-11-07T05:31:56Z",
    "telephonyPartiallyProvisionedAt": "2023-11-07T05:31:56Z",
    "telephonyReadyAt": "2023-11-07T05:31:56Z",
    "failedAt": "2023-11-07T05:31:56Z",
    "activatedAt": "2023-11-07T05:31:56Z",
    "industry": "<string>",
    "businessDescription": "<string>",
    "targetAudience": "<string>",
    "offer": "<string>",
    "websiteNeeds": "<string>",
    "serviceArea": "<string>",
    "complianceNotes": "<string>",
    "domainOptions": [
      {
        "domainName": "<string>",
        "whyItFits": "<string>",
        "industryRelevance": "<string>",
        "trustConcerns": "<string>",
        "estimatedAnnualCost": "<string>",
        "availabilityStatus": "<string>",
        "recommended": true
      }
    ],
    "selectedDomain": "<string>",
    "domainApprovedAt": "2023-11-07T05:31:56Z",
    "websiteUrl": "<string>",
    "tenDlcDraft": {
      "companyName": "<string>",
      "contactName": "<string>",
      "contactEmail": "<string>",
      "contactPhone": "<string>",
      "ein": "<string>",
      "websiteUrl": "<string>",
      "industry": "<string>",
      "useCase": "<string>",
      "useCaseDescription": "<string>",
      "messageExamples": [
        "<string>"
      ],
      "optInLanguage": "<string>",
      "privacyPolicyUrl": "<string>",
      "termsUrl": "<string>",
      "expectedMonthlyVolume": "<string>",
      "leadSource": "<string>",
      "trustedFormRequired": true,
      "complianceWarnings": [
        "<string>"
      ],
      "missingFields": [
        "<string>"
      ],
      "lastSubmittedAt": "2023-11-07T05:31:56Z",
      "rejectionReason": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "version": "<string>"
    },
    "events": [
      {
        "id": "<string>",
        "type": "<string>",
        "title": "<string>",
        "details": "<string>",
        "status": "<string>",
        "actorName": "<string>",
        "failureReason": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "compliancePolicy": {
    "enabled": true,
    "allowedStates": [
      "<string>"
    ],
    "allowedProducts": [
      "<string>"
    ],
    "requireLeadState": true,
    "requireAgentLicenseState": true,
    "requireProduct": true,
    "requireTrustedFormForAutomations": true,
    "requireSourceComplianceApproval": true
  },
  "name": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

Body

The updated business profile data.

Request payload for business.

​
name
string
required

The display name for the entity.

Maximum string length: 255
​
secondaryName
string | null

The secondary name value for this business.

​
status
enum<string> | null

Defines the supported Business Status values.

Available options:
SettingUp,
SetupCompleted,
Active
​
enabled
boolean | null
​
adminEnablementOverride
object
​
autoRefillEnabled
boolean | null

Whether auto refill is enabled for this business wallet.

​
autoRefillAmount
string<double> | null

The monetary auto refill amount for this business wallet.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
​
autoRefillTrigger
string<double> | null

The auto refill trigger value for this business wallet.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
​
phone
string | null

The phone number associated with this business.

​
address
object

The postal address associated with this business.

​
website
string | null

The website URL associated with this business.

​
vertical
string | null

The vertical value for this business.

​
description
string | null

The human-readable description of this business.

​
ein
string | null

The EIN value for this business.

​
isYoungerThan90
boolean | null

Whether this business is younger than90.

​
einDocument
object

The EIN document value for this business.

​
phones
object[] | null

The phones included with this business.

​
setupStep
enum<string> | null

Defines the supported Business Setup Step values.

Available options:
DomainFinding,
DomainOptionsFound,
SiteGenerating,
SiteGenerated,
BrandSubmitted,
BrandApproved,
CampaignSubmitted,
CampaignApproved,
CarrierReviewing,
TenDlcComplete,
Complete
​
activation
object

The activation value for this business.

​
compliancePolicy
object

The compliance policy value for this business.

​
id
string | null

The unique identifier for the entity, when updating an existing entity.

Response

Returns the business response.

API response containing business data returned to callers.

​
secondaryName
string | null

The secondary name value for this business.

​
user
object

The user value for this business.

​
accountBalance
string<double>

The wallet balance owned by this business.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
​
autoRefillEnabled
boolean

Whether auto refill is enabled for this business wallet.

​
autoRefillAmount
string<double> | null

The monetary auto refill amount for this business wallet.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
​
autoRefillTrigger
string<double> | null

The auto refill trigger value for this business wallet.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
​
status
enum<string> | null

Defines the supported Business Status values.

Available options:
SettingUp,
SetupCompleted,
Active
​
enabled
boolean
​
adminEnablementOverride
object
​
phone
string | null

The phone number associated with this business.

​
website
string | null

The website URL associated with this business.

​
address
object

The postal address associated with this business.

​
vertical
string | null

The vertical value for this business.

​
description
string | null

The human-readable description of this business.

​
ein
string | null

The EIN value for this business.

​
einDocument
object

The EIN document value for this business.

​
domain
string | null

The domain name associated with this business.

​
phones
object[] | null

The phones included with this business.

​
site
object

The site value for this business.

​
setupStep
enum<string> | null

Defines the supported Business Setup Step values.

Available options:
DomainFinding,
DomainOptionsFound,
SiteGenerating,
SiteGenerated,
BrandSubmitted,
BrandApproved,
CampaignSubmitted,
CampaignApproved,
CarrierReviewing,
TenDlcComplete,
Complete
​
activation
object

The activation value for this business.

​
compliancePolicy
object

The compliance policy value for this business.

​
name
string

The display name for the entity.

​
id
string

The unique identifier for the entity.

​
createdAt
string<date-time>

The date and time when the entity was created.

​
modifiedAt
string<date-time> | null

The date and time when the entity was last modified, if applicable.