Book an appointment

POST

appointments

Book an appointment

curl --request POST \
  --url https://app.lobbystack.com/api/v1/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "starts_at": "2023-11-07T05:31:56Z",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_phone": "<string>",
  "contact_name": "<string>",
  "staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "notes": "<string>",
  "sms_consent": true
}
'

import requests

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

payload = {
    "service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "starts_at": "2023-11-07T05:31:56Z",
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_phone": "<string>",
    "contact_name": "<string>",
    "staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "notes": "<string>",
    "sms_consent": True
}
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({
    service_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    starts_at: '2023-11-07T05:31:56Z',
    contact_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    contact_phone: '<string>',
    contact_name: '<string>',
    staff_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    notes: '<string>',
    sms_consent: true
  })
};

fetch('https://app.lobbystack.com/api/v1/appointments', 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/appointments",
  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([
    'service_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'starts_at' => '2023-11-07T05:31:56Z',
    'contact_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'contact_phone' => '<string>',
    'contact_name' => '<string>',
    'staff_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'notes' => '<string>',
    'sms_consent' => true
  ]),
  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/appointments"

	payload := strings.NewReader("{\n  \"service_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"starts_at\": \"2023-11-07T05:31:56Z\",\n  \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contact_phone\": \"<string>\",\n  \"contact_name\": \"<string>\",\n  \"staff_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"notes\": \"<string>\",\n  \"sms_consent\": true\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/appointments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"service_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"starts_at\": \"2023-11-07T05:31:56Z\",\n  \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contact_phone\": \"<string>\",\n  \"contact_name\": \"<string>\",\n  \"staff_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"notes\": \"<string>\",\n  \"sms_consent\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"service_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"starts_at\": \"2023-11-07T05:31:56Z\",\n  \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contact_phone\": \"<string>\",\n  \"contact_name\": \"<string>\",\n  \"staff_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"notes\": \"<string>\",\n  \"sms_consent\": true\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "confirmed",
    "starts_at": "2023-11-07T05:31:56Z",
    "ends_at": "2023-11-07T05:31:56Z",
    "timezone": "<string>",
    "service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "service_name": "<string>",
    "staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "staff_name": "<string>",
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_name": "<string>",
    "contact_phone": "<string>",
    "source": "<string>",
    "calendar_sync_status": "pending",
    "notes": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "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>"
      }
    ]
  }
}

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

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

Authorizations

Authorization

string

header

required

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.

Headers

LobbyStack-Business

string<uuid>

The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business.

Idempotency-Key

string

A unique value, up to 255 characters, that makes retries of this request safe for 24 hours.

Maximum string length: 255

Body

application/json

service_id

string<uuid>

required

Stable identifier (UUID).

starts_at

string<date-time>

required

Start time. Use a starts_at value from GET /availability.

contact_id

string<uuid>

An existing contact with a phone number. Provide contact_id or contact_phone.

contact_phone

string

Phone number in E.164 format.

Pattern: ^\+[1-9]\d{6,14}$

contact_name

string

Required string length: 1 - 200

staff_id

string<uuid>

Book with this active staff member. Without it, LobbyStack picks one who is free.

notes

string

Notes on the appointment. The receptionist can read them to a verified caller.

Maximum string length: 2000

True only if the customer agreed to receive confirmation and reminder texts. Self-hosted instances only: on LobbyStack Cloud, texts come from LobbyStack's shared number, and only the receptionist can collect that consent, on a call.

Response

Created

data

object

required

Show child attributes

Book an appointment

curl --request POST \
  --url https://app.lobbystack.com/api/v1/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "starts_at": "2023-11-07T05:31:56Z",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_phone": "<string>",
  "contact_name": "<string>",
  "staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "notes": "<string>",
  "sms_consent": true
}
'

import requests

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

payload = {
    "service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "starts_at": "2023-11-07T05:31:56Z",
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_phone": "<string>",
    "contact_name": "<string>",
    "staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "notes": "<string>",
    "sms_consent": True
}
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({
    service_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    starts_at: '2023-11-07T05:31:56Z',
    contact_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    contact_phone: '<string>',
    contact_name: '<string>',
    staff_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    notes: '<string>',
    sms_consent: true
  })
};

fetch('https://app.lobbystack.com/api/v1/appointments', 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/appointments",
  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([
    'service_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'starts_at' => '2023-11-07T05:31:56Z',
    'contact_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'contact_phone' => '<string>',
    'contact_name' => '<string>',
    'staff_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'notes' => '<string>',
    'sms_consent' => true
  ]),
  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/appointments"

	payload := strings.NewReader("{\n  \"service_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"starts_at\": \"2023-11-07T05:31:56Z\",\n  \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contact_phone\": \"<string>\",\n  \"contact_name\": \"<string>\",\n  \"staff_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"notes\": \"<string>\",\n  \"sms_consent\": true\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/appointments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"service_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"starts_at\": \"2023-11-07T05:31:56Z\",\n  \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contact_phone\": \"<string>\",\n  \"contact_name\": \"<string>\",\n  \"staff_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"notes\": \"<string>\",\n  \"sms_consent\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"service_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"starts_at\": \"2023-11-07T05:31:56Z\",\n  \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contact_phone\": \"<string>\",\n  \"contact_name\": \"<string>\",\n  \"staff_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"notes\": \"<string>\",\n  \"sms_consent\": true\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "confirmed",
    "starts_at": "2023-11-07T05:31:56Z",
    "ends_at": "2023-11-07T05:31:56Z",
    "timezone": "<string>",
    "service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "service_name": "<string>",
    "staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "staff_name": "<string>",
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_name": "<string>",
    "contact_phone": "<string>",
    "source": "<string>",
    "calendar_sync_status": "pending",
    "notes": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "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>"
      }
    ]
  }
}

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

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

Get started

General

Agents

Settings

White label

API

AI assistants

API reference

Self-hosting

Authorizations

Headers

Body

Response