Create an organization account
curl --request POST \
--url https://api.leadping.ai/organizations/me \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"timeZoneId": "<string>",
"name": "<string>",
"secondaryName": "<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,
"offer": "<string>",
"targetAudience": "<string>"
}
'import requests
url = "https://api.leadping.ai/organizations/me"
payload = {
"timeZoneId": "<string>",
"name": "<string>",
"secondaryName": "<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,
"offer": "<string>",
"targetAudience": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"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/organizations/me");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"timeZoneId\": \"<string>\",\n \"name\": \"<string>\",\n \"secondaryName\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"province\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"additionalInfo\": \"<string>\"\n },\n \"website\": \"<string>\",\n \"vertical\": \"<string>\",\n \"description\": \"<string>\",\n \"ein\": \"<string>\",\n \"isYoungerThan90\": true,\n \"offer\": \"<string>\",\n \"targetAudience\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.post("https://api.leadping.ai/organizations/me")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"timeZoneId\": \"<string>\",\n \"name\": \"<string>\",\n \"secondaryName\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"province\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"additionalInfo\": \"<string>\"\n },\n \"website\": \"<string>\",\n \"vertical\": \"<string>\",\n \"description\": \"<string>\",\n \"ein\": \"<string>\",\n \"isYoungerThan90\": true,\n \"offer\": \"<string>\",\n \"targetAudience\": \"<string>\"\n}")
.asString();const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
timeZoneId: '<string>',
name: '<string>',
secondaryName: '<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,
offer: '<string>',
targetAudience: '<string>'
})
};
fetch('https://api.leadping.ai/organizations/me', 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/organizations/me"
payload := strings.NewReader("{\n \"timeZoneId\": \"<string>\",\n \"name\": \"<string>\",\n \"secondaryName\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"province\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"additionalInfo\": \"<string>\"\n },\n \"website\": \"<string>\",\n \"vertical\": \"<string>\",\n \"description\": \"<string>\",\n \"ein\": \"<string>\",\n \"isYoungerThan90\": true,\n \"offer\": \"<string>\",\n \"targetAudience\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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/organizations/me",
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([
'timeZoneId' => '<string>',
'name' => '<string>',
'secondaryName' => '<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,
'offer' => '<string>',
'targetAudience' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"timeZoneId": "<string>",
"isDemo": true,
"secondaryName": "<string>",
"user": {
"id": "<string>",
"name": "<string>"
},
"accountBalance": 123,
"billingPlan": "Annual",
"subscriptionStatus": "Pending",
"billingState": {
"hasStripeCustomer": true,
"hasPaymentMethod": true,
"phoneNumberQuantity": 123,
"organizationMemberQuantity": 123,
"organizationMemberAssignedQuantity": 123,
"pendingBillingPlan": "Annual",
"billingPlanChangeEffectiveAt": "2023-11-07T05:31:56Z",
"planRenewalAt": "2023-11-07T05:31:56Z",
"planPeriodStartAt": "2023-11-07T05:31:56Z",
"cancelAt": "2023-11-07T05:31:56Z",
"dunning": {
"stage": "<string>",
"paymentFailedAt": "2023-11-07T05:31:56Z",
"lastFailedInvoiceStatus": "<string>",
"retryAttemptCount": 123,
"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": 123,
"autoRefillTrigger": 123,
"status": "SettingUp",
"setupStatus": "Personal",
"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>"
},
"setupStep": "DomainFinding",
"activation": {
"status": "DraftOnboarding",
"onboardingStatus": "Draft",
"paymentStatus": "PaymentMethodPending",
"billingSubscriptionStatus": "Pending",
"launchReviewStatus": "NotReady",
"controlledLaunch": true,
"telephonyStatus": "NotStarted",
"websiteStatus": "NotStarted",
"tenDlcStatus": "NotStarted",
"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>",
"organizationDescription": "<string>",
"targetAudience": "<string>",
"offer": "<string>",
"websiteNeeds": "<string>",
"serviceArea": "<string>",
"complianceNotes": "<string>",
"domainOptions": [
{
"domainName": "<string>",
"whyItFits": "<string>",
"industryRelevance": "<string>",
"trustConcerns": "<string>",
"estimatedAnnualCost": 123,
"availabilityStatus": "<string>",
"recommended": true
}
],
"domainSearchStage": "Queued",
"domainSearchId": "<string>",
"domainSearchAttempt": 123,
"availableDomainCount": 123,
"domainSearchUpdatedAt": "2023-11-07T05:31:56Z",
"selectedDomain": "<string>",
"domainApprovedAt": "2023-11-07T05:31:56Z",
"domainPurchasedAt": "2023-11-07T05:31:56Z",
"websiteGenerationResult": "<string>",
"websiteUrl": "<string>",
"tenDlcDraft": {
"companyName": "<string>",
"contactName": "<string>",
"contactEmail": "jsmith@example.com",
"contactPhone": "<string>",
"ein": "<string>",
"websiteUrl": "<string>",
"industry": "<string>",
"useCase": "<string>",
"useCaseDescription": "<string>",
"messageExamples": [
"<string>"
],
"optInLanguage": "<string>",
"privacyPolicyUrl": "<string>",
"termsUrl": "<string>",
"expectedMonthlyVolume": 123,
"trustedFormRequired": true,
"complianceWarnings": [
"<string>"
],
"missingFields": [
"<string>"
],
"brandStatus": "NotSubmitted",
"campaignStatus": "NotSubmitted",
"lastSubmittedAt": "2023-11-07T05:31:56Z",
"rejectionReason": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"version": 123
},
"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>"
],
"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": "about:blank",
"title": "Bad Request",
"status": 400,
"detail": "The request could not be completed."
}{
"type": "about:blank",
"title": "Unauthorized",
"status": 401,
"detail": "The request could not be completed."
}{
"type": "about:blank",
"title": "Too Many Requests",
"status": 429,
"detail": "The request could not be completed."
}Organizations
Create an organization account
Creates an organization account for the authenticated user, assigns them as its owner, and makes it their active organization context.
POST
/
organizations
/
me
Create an organization account
curl --request POST \
--url https://api.leadping.ai/organizations/me \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"timeZoneId": "<string>",
"name": "<string>",
"secondaryName": "<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,
"offer": "<string>",
"targetAudience": "<string>"
}
'import requests
url = "https://api.leadping.ai/organizations/me"
payload = {
"timeZoneId": "<string>",
"name": "<string>",
"secondaryName": "<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,
"offer": "<string>",
"targetAudience": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"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/organizations/me");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"timeZoneId\": \"<string>\",\n \"name\": \"<string>\",\n \"secondaryName\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"province\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"additionalInfo\": \"<string>\"\n },\n \"website\": \"<string>\",\n \"vertical\": \"<string>\",\n \"description\": \"<string>\",\n \"ein\": \"<string>\",\n \"isYoungerThan90\": true,\n \"offer\": \"<string>\",\n \"targetAudience\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.post("https://api.leadping.ai/organizations/me")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"timeZoneId\": \"<string>\",\n \"name\": \"<string>\",\n \"secondaryName\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"province\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"additionalInfo\": \"<string>\"\n },\n \"website\": \"<string>\",\n \"vertical\": \"<string>\",\n \"description\": \"<string>\",\n \"ein\": \"<string>\",\n \"isYoungerThan90\": true,\n \"offer\": \"<string>\",\n \"targetAudience\": \"<string>\"\n}")
.asString();const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
timeZoneId: '<string>',
name: '<string>',
secondaryName: '<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,
offer: '<string>',
targetAudience: '<string>'
})
};
fetch('https://api.leadping.ai/organizations/me', 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/organizations/me"
payload := strings.NewReader("{\n \"timeZoneId\": \"<string>\",\n \"name\": \"<string>\",\n \"secondaryName\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"province\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"additionalInfo\": \"<string>\"\n },\n \"website\": \"<string>\",\n \"vertical\": \"<string>\",\n \"description\": \"<string>\",\n \"ein\": \"<string>\",\n \"isYoungerThan90\": true,\n \"offer\": \"<string>\",\n \"targetAudience\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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/organizations/me",
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([
'timeZoneId' => '<string>',
'name' => '<string>',
'secondaryName' => '<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,
'offer' => '<string>',
'targetAudience' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"timeZoneId": "<string>",
"isDemo": true,
"secondaryName": "<string>",
"user": {
"id": "<string>",
"name": "<string>"
},
"accountBalance": 123,
"billingPlan": "Annual",
"subscriptionStatus": "Pending",
"billingState": {
"hasStripeCustomer": true,
"hasPaymentMethod": true,
"phoneNumberQuantity": 123,
"organizationMemberQuantity": 123,
"organizationMemberAssignedQuantity": 123,
"pendingBillingPlan": "Annual",
"billingPlanChangeEffectiveAt": "2023-11-07T05:31:56Z",
"planRenewalAt": "2023-11-07T05:31:56Z",
"planPeriodStartAt": "2023-11-07T05:31:56Z",
"cancelAt": "2023-11-07T05:31:56Z",
"dunning": {
"stage": "<string>",
"paymentFailedAt": "2023-11-07T05:31:56Z",
"lastFailedInvoiceStatus": "<string>",
"retryAttemptCount": 123,
"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": 123,
"autoRefillTrigger": 123,
"status": "SettingUp",
"setupStatus": "Personal",
"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>"
},
"setupStep": "DomainFinding",
"activation": {
"status": "DraftOnboarding",
"onboardingStatus": "Draft",
"paymentStatus": "PaymentMethodPending",
"billingSubscriptionStatus": "Pending",
"launchReviewStatus": "NotReady",
"controlledLaunch": true,
"telephonyStatus": "NotStarted",
"websiteStatus": "NotStarted",
"tenDlcStatus": "NotStarted",
"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>",
"organizationDescription": "<string>",
"targetAudience": "<string>",
"offer": "<string>",
"websiteNeeds": "<string>",
"serviceArea": "<string>",
"complianceNotes": "<string>",
"domainOptions": [
{
"domainName": "<string>",
"whyItFits": "<string>",
"industryRelevance": "<string>",
"trustConcerns": "<string>",
"estimatedAnnualCost": 123,
"availabilityStatus": "<string>",
"recommended": true
}
],
"domainSearchStage": "Queued",
"domainSearchId": "<string>",
"domainSearchAttempt": 123,
"availableDomainCount": 123,
"domainSearchUpdatedAt": "2023-11-07T05:31:56Z",
"selectedDomain": "<string>",
"domainApprovedAt": "2023-11-07T05:31:56Z",
"domainPurchasedAt": "2023-11-07T05:31:56Z",
"websiteGenerationResult": "<string>",
"websiteUrl": "<string>",
"tenDlcDraft": {
"companyName": "<string>",
"contactName": "<string>",
"contactEmail": "jsmith@example.com",
"contactPhone": "<string>",
"ein": "<string>",
"websiteUrl": "<string>",
"industry": "<string>",
"useCase": "<string>",
"useCaseDescription": "<string>",
"messageExamples": [
"<string>"
],
"optInLanguage": "<string>",
"privacyPolicyUrl": "<string>",
"termsUrl": "<string>",
"expectedMonthlyVolume": 123,
"trustedFormRequired": true,
"complianceWarnings": [
"<string>"
],
"missingFields": [
"<string>"
],
"brandStatus": "NotSubmitted",
"campaignStatus": "NotSubmitted",
"lastSubmittedAt": "2023-11-07T05:31:56Z",
"rejectionReason": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"version": 123
},
"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>"
],
"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": "about:blank",
"title": "Bad Request",
"status": 400,
"detail": "The request could not be completed."
}{
"type": "about:blank",
"title": "Unauthorized",
"status": 401,
"detail": "The request could not be completed."
}{
"type": "about:blank",
"title": "Too Many Requests",
"status": 429,
"detail": "The request could not be completed."
}Authorizations
Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.
Body
application/jsonapplication/*+json
The organization profile, contact, and initial setup details to create.
Defines the fields clients can send when working with organization profile.
Default timezone for organization reporting and display when a user has no personal preference.
Primary organization name.
Alternate organization name or DBA shown in Leadping.
Phone details for the lead, user, or organization represented by this organization profile request.
Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
Show child attributes
Show child attributes
Organization website URL used for compliance, brand review, and lead attribution.
Industry vertical used for lead routing, compliance review, and reporting.
Human-readable description that explains this organization profile request to API users.
Employer Identification Number used for organization and 10DLC verification.
Whether the organization was formed less than 90 days ago.
Main service or offer described during organization setup.
Intended audience described during organization setup.
Response
Created
Describes organization profile data returned by Leadping.
Default timezone for organization reporting and display when a user has no personal preference.
Alternate organization name or DBA shown in Leadping.
Provides a compact API reference to another resource using its stable identifier and human-readable display name.
Show child attributes
Show child attributes
Current wallet balance available to the organization.
Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
Available options:
Annual, Monthly Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states.
Available options:
Pending, Active, Overdue, Canceled Customer-safe billing state for a Leadping organization.
Show child attributes
Show child attributes
Indicates whether automatic wallet refill is enabled for the organization.
Wallet refill amount charged when automatic refill is triggered.
Wallet balance threshold that triggers automatic refill.
Describes an organization's account lifecycle and whether it can actively use Leadping services.
Available options:
SettingUp, SetupCompleted, Active Describes a user's progress through required Leadping profile and account setup tasks.
Available options:
Personal, Organization, Details, Compliance, Phone, Plan, Billing, Review, Complete Indicates whether this organization profile response is active and available in the Leadping API.
Phone details for the lead, user, or organization represented by this organization profile response.
Organization website URL used for compliance, brand review, and lead attribution.
Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
Show child attributes
Show child attributes
Name used for invoices, receipts, and payment processor billing records.
Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
Show child attributes
Show child attributes
Tax identifier printed on billing documents. This may differ from the organization verification EIN.
Industry vertical used for lead routing, compliance review, and reporting.
Human-readable description that explains this organization profile response to API users.
Employer Identification Number used for organization and 10DLC verification.
Extends an identifier-and-name resource reference with an optional string value used for display or selection metadata.
Show child attributes
Show child attributes
Domain name connected to the organization website or activation workflow.
Phone numbers assigned to this organization.
Show child attributes
Show child attributes
Provides a compact API reference to another resource using its stable identifier and human-readable display name.
Show child attributes
Show child attributes
Identifies a discrete billing, telephony, compliance, or configuration stage in organization provisioning.
Available options:
DomainFinding, DomainOptionsFound, SiteGenerating, SiteGenerated, BrandSubmitted, BrandApproved, CampaignSubmitted, CampaignApproved, CarrierReviewing, TenDlcComplete, Complete Describes organization activation state data used in Leadping API requests and responses.
Show child attributes
Show child attributes
Describes organization compliance policy data used in Leadping API requests and responses.
Show child attributes
Show child attributes
Human-readable display name of the resource.
Stable unique identifier of the resource.
UTC timestamp when the resource was created.
UTC timestamp when the resource was last modified, or null when it has not been updated.