Partner

Make a prospect demo

Makes a demo receptionist from a prospect’s website, under the partner’s brand, and returns its link once. The demo reads the website first: poll GET /partner/demos/ until ready says everything is, then publish it. The partner needs a subdomain or its own domain first, or it’s a 409. This endpoint ignores Idempotency-Key, so LobbyStack never stores a copy of the link; after a network error, look in GET /partner/demos before you retry. A partner’s keys can make 30 demos an hour between them.

POST

partner

demos

curl --request POST \
  --url https://app.lobbystack.com/api/v1/partner/demos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "website_url": "<string>",
  "greeting": "<string>",
  "timezone": "<string>",
  "suggested_prompts": [
    "<string>"
  ]
}
'

import requests

url = "https://app.lobbystack.com/api/v1/partner/demos"

payload = {
    "name": "<string>",
    "website_url": "<string>",
    "greeting": "<string>",
    "timezone": "<string>",
    "suggested_prompts": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    website_url: '<string>',
    greeting: '<string>',
    timezone: '<string>',
    suggested_prompts: ['<string>']
  })
};

fetch('https://app.lobbystack.com/api/v1/partner/demos', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.lobbystack.com/api/v1/partner/demos",
  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([
    'name' => '<string>',
    'website_url' => '<string>',
    'greeting' => '<string>',
    'timezone' => '<string>',
    'suggested_prompts' => [
        '<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;
}

package main

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

func main() {

	url := "https://app.lobbystack.com/api/v1/partner/demos"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"greeting\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"suggested_prompts\": [\n    \"<string>\"\n  ]\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))

}

HttpResponse<String> response = Unirest.post("https://app.lobbystack.com/api/v1/partner/demos")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"greeting\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"suggested_prompts\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.lobbystack.com/api/v1/partner/demos")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"greeting\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"suggested_prompts\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "preparing",
    "access_level": "full",
    "token": "<string>",
    "url": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Autorizaciones

Authorization

string

header

requerido

An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create, phone_numbers:purchase, partner:read, partner.businesses:write, partner.demos:write, partner.packages:write, partner.branding:write, partner.templates:write, partner.team:write, partner.billing:read, partner.billing:write. Only platform keys can hold businesses:create and users:create, and only a key a partner made in its console can hold the partner scopes, which the Partner endpoints use. Only a partner's owners grant partner.billing:read and partner.billing:write.

Cuerpo

application/json

name

string

requerido

The prospect's business name.

Required string length: 1 - 120

website_url

string<uri>

requerido

The prospect's website, which the demo reads.

Maximum string length: 2000

access_level

enum<string>

What the business's own team gets once someone claims the demo. Defaults to full.

Opciones disponibles:

full,

activity

locale

enum<string>

The language the demo's receptionist speaks first. Defaults to en.

Opciones disponibles:

en,

fr,

es,

sr,

de,

pt,

it,

nl,

pl,

tr,

vi,

tl,

sv,

ru,

uk

greeting

string

Maximum string length: 500

timezone

string

IANA time zone, for example America/Toronto.

Maximum string length: 80

suggested_prompts

string[]

What the demo page suggests the prospect ask. Publishing needs at least two.

Maximum array length: 6

Required string length: 1 - 200

Respuesta

Created

data

object

requerido

Show child attributes

Make a prospect demo

curl --request POST \
  --url https://app.lobbystack.com/api/v1/partner/demos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "website_url": "<string>",
  "greeting": "<string>",
  "timezone": "<string>",
  "suggested_prompts": [
    "<string>"
  ]
}
'

import requests

url = "https://app.lobbystack.com/api/v1/partner/demos"

payload = {
    "name": "<string>",
    "website_url": "<string>",
    "greeting": "<string>",
    "timezone": "<string>",
    "suggested_prompts": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    website_url: '<string>',
    greeting: '<string>',
    timezone: '<string>',
    suggested_prompts: ['<string>']
  })
};

fetch('https://app.lobbystack.com/api/v1/partner/demos', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.lobbystack.com/api/v1/partner/demos",
  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([
    'name' => '<string>',
    'website_url' => '<string>',
    'greeting' => '<string>',
    'timezone' => '<string>',
    'suggested_prompts' => [
        '<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;
}

package main

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

func main() {

	url := "https://app.lobbystack.com/api/v1/partner/demos"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"greeting\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"suggested_prompts\": [\n    \"<string>\"\n  ]\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))

}

HttpResponse<String> response = Unirest.post("https://app.lobbystack.com/api/v1/partner/demos")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"greeting\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"suggested_prompts\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.lobbystack.com/api/v1/partner/demos")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"greeting\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"suggested_prompts\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "preparing",
    "access_level": "full",
    "token": "<string>",
    "url": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Primeros pasos

General

Agentes

Configuración

Marca blanca

API

Asistentes de IA

Referencia de la API

Autoalojamiento

Make a prospect demo

Autorizaciones

Cuerpo

Respuesta