Switch current business account context

curl --request POST \
  --url https://api.leadping.ai/businesses/me/switch \
  --header 'Content-Type: application/json' \
  --data '
{
  "businessId": "<string>"
}
'

import requests

url = "https://api.leadping.ai/businesses/me/switch"

payload = { "businessId": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/businesses/me/switch");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"businessId\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

HttpResponse<String> response = Unirest.post("https://api.leadping.ai/businesses/me/switch")
  .header("Content-Type", "application/json")
  .body("{\n  \"businessId\": \"<string>\"\n}")
  .asString();

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({businessId: '<string>'})
};

fetch('https://api.leadping.ai/businesses/me/switch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leadping.ai/businesses/me/switch"

	payload := strings.NewReader("{\n  \"businessId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/businesses/me/switch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'businessId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "secondaryName": "<string>",
  "user": {
    "id": "<string>",
    "name": "<string>"
  },
  "accountBalance": "<string>",
  "billingState": {
    "hasStripeCustomer": true,
    "hasPaymentMethod": true,
    "phoneNumberQuantity": "<string>",
    "businessUserQuantity": "<string>",
    "businessUserAssignedQuantity": "<string>",
    "billingPlanChangeEffectiveAt": "2023-11-07T05:31:56Z",
    "planRenewalAt": "2023-11-07T05:31:56Z",
    "cancelAt": "2023-11-07T05:31:56Z",
    "dunning": {
      "stage": "<string>",
      "paymentFailedAt": "2023-11-07T05:31:56Z",
      "lastFailedInvoiceStatus": "<string>",
      "retryAttemptCount": "<string>",
      "nextRetryAt": "2023-11-07T05:31:56Z",
      "gracePeriodEndsAt": "2023-11-07T05:31:56Z",
      "outboundRestrictedAt": "2023-11-07T05:31:56Z",
      "outboundSuspendedAt": "2023-11-07T05:31:56Z",
      "finalCancellationAt": "2023-11-07T05:31:56Z",
      "lastUpdatedAt": "2023-11-07T05:31:56Z"
    },
    "lastSubscriptionEventAt": "2023-11-07T05:31:56Z",
    "lastPaymentMethodEventAt": "2023-11-07T05:31:56Z"
  },
  "autoRefillEnabled": true,
  "autoRefillAmount": "<string>",
  "autoRefillTrigger": "<string>",
  "enabled": true,
  "phone": "<string>",
  "website": "<string>",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "province": "<string>",
    "region": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "additionalInfo": "<string>"
  },
  "billingName": "<string>",
  "billingAddress": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "province": "<string>",
    "region": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "additionalInfo": "<string>"
  },
  "billingTaxId": "<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,
    "tenDlcApplicationId": "<string>",
    "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>",
        "actor": {
          "id": "<string>",
          "name": "<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"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

POST

businesses

switch

Switch current business account context

curl --request POST \
  --url https://api.leadping.ai/businesses/me/switch \
  --header 'Content-Type: application/json' \
  --data '
{
  "businessId": "<string>"
}
'

import requests

url = "https://api.leadping.ai/businesses/me/switch"

payload = { "businessId": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/businesses/me/switch");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"businessId\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

HttpResponse<String> response = Unirest.post("https://api.leadping.ai/businesses/me/switch")
  .header("Content-Type", "application/json")
  .body("{\n  \"businessId\": \"<string>\"\n}")
  .asString();

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({businessId: '<string>'})
};

fetch('https://api.leadping.ai/businesses/me/switch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leadping.ai/businesses/me/switch"

	payload := strings.NewReader("{\n  \"businessId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/businesses/me/switch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'businessId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "secondaryName": "<string>",
  "user": {
    "id": "<string>",
    "name": "<string>"
  },
  "accountBalance": "<string>",
  "billingState": {
    "hasStripeCustomer": true,
    "hasPaymentMethod": true,
    "phoneNumberQuantity": "<string>",
    "businessUserQuantity": "<string>",
    "businessUserAssignedQuantity": "<string>",
    "billingPlanChangeEffectiveAt": "2023-11-07T05:31:56Z",
    "planRenewalAt": "2023-11-07T05:31:56Z",
    "cancelAt": "2023-11-07T05:31:56Z",
    "dunning": {
      "stage": "<string>",
      "paymentFailedAt": "2023-11-07T05:31:56Z",
      "lastFailedInvoiceStatus": "<string>",
      "retryAttemptCount": "<string>",
      "nextRetryAt": "2023-11-07T05:31:56Z",
      "gracePeriodEndsAt": "2023-11-07T05:31:56Z",
      "outboundRestrictedAt": "2023-11-07T05:31:56Z",
      "outboundSuspendedAt": "2023-11-07T05:31:56Z",
      "finalCancellationAt": "2023-11-07T05:31:56Z",
      "lastUpdatedAt": "2023-11-07T05:31:56Z"
    },
    "lastSubscriptionEventAt": "2023-11-07T05:31:56Z",
    "lastPaymentMethodEventAt": "2023-11-07T05:31:56Z"
  },
  "autoRefillEnabled": true,
  "autoRefillAmount": "<string>",
  "autoRefillTrigger": "<string>",
  "enabled": true,
  "phone": "<string>",
  "website": "<string>",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "province": "<string>",
    "region": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "additionalInfo": "<string>"
  },
  "billingName": "<string>",
  "billingAddress": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "province": "<string>",
    "region": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "additionalInfo": "<string>"
  },
  "billingTaxId": "<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,
    "tenDlcApplicationId": "<string>",
    "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>",
        "actor": {
          "id": "<string>",
          "name": "<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"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

Body

The selected business identifier.

Request schema for the Leadping API business switch request, including the fields clients can send.

businessId

string

Business ID to switch into for the current Leadping session.

Response

Returns the business response.

Response schema for the Leadping API business profile response returned to authenticated clients.

secondaryName

string | null

Alternate business name or DBA shown in Leadping.

user

object | null

User summary connected to this business profile response.

Show child attributes

accountBalance

string<double>

Current wallet balance available to the business.

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

billingPlan

enum<string> | null

Defines the supported Billing Plan values.

Available options:

Annual,

Monthly

subscriptionStatus

enum<string> | null

Defines the supported Subscription Status values.

Available options:

Pending,

Active,

Overdue,

Canceled

billingState

object | null

Customer-safe billing state for this business.

Show child attributes

autoRefillEnabled

boolean

Indicates whether automatic wallet refill is enabled for the business.

autoRefillAmount

string<double> | null

Wallet refill amount charged when automatic refill is triggered.

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

autoRefillTrigger

string<double> | null

Wallet balance threshold that triggers automatic refill.

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

status

enum<string> | null

Defines the supported Business Status values.

Available options:

SettingUp,

SetupCompleted,

Active

setupStatus

enum<string> | null

Defines the supported User Setup Status values.

Available options:

Personal,

Business,

Details,

Compliance,

Phone,

Plan,

Billing,

Review,

Complete

enabled

boolean

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

phone

string | null

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

website

string | null

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

address

object | null

Postal address for the business, lead, or contact represented by this business profile response.

Show child attributes

billingName

string | null

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

billingAddress

object | null

Postal address used for invoices, receipts, and payment processor billing records.

Show child attributes

billingTaxId

string | null

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

vertical

string | null

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

description

string | null

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

ein

string | null

Employer Identification Number used for business and 10DLC verification.

einDocument

object | null

Uploaded EIN document reference used for business verification.

Show child attributes

domain

string | null

Domain name connected to the business website or activation workflow.

phones

object[] | null

Phone numbers assigned to this business.

Show child attributes

site

object | null

Leadping website record connected to this business.

Show child attributes

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 | null

Business activation state covering site, billing, compliance, and telephony readiness.

Show child attributes

compliancePolicy

object | null

Compliance policy configuration for the business.

Show child attributes

name

string

The display name for the entity.

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.

List business switch options List users for the current business

Analytics

Automations

Contact

Conversations

Dispositions

Feedback

Leads

LeadStatuses

Notifications

OutboundDelivery

Sources

Suppressions

Tags

Users

Calls

PhoneNumbers

Sms

Telephony

UserDataExports

CallEvents

Events

SmsEvents

Businesses

PaymentMethods

Transactions

Usage

Wallets

Switch current business account context

Body

Response