Reschedule appointment

curl --request PUT \
  --url https://api.opencals.com/storefront/appointments/{appointmentId}/reschedule \
  --header 'Content-Type: application/json' \
  --data '
{
  "slot": {
    "fromDate": "2023-06-15",
    "fromTime": "09:00:00",
    "toDate": "2023-06-15",
    "toTime": "10:00:00",
    "productId": "123e4567-e89b-12d3-a456-426614174001",
    "locationId": "123e4567-e89b-12d3-a456-426614174002",
    "staffMemberId": "123e4567-e89b-12d3-a456-426614174003"
  },
  "notifyCustomer": true,
  "isManual": false,
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Suite 456",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "USA"
  }
}
'

import requests

url = "https://api.opencals.com/storefront/appointments/{appointmentId}/reschedule"

payload = {
    "slot": {
        "fromDate": "2023-06-15",
        "fromTime": "09:00:00",
        "toDate": "2023-06-15",
        "toTime": "10:00:00",
        "productId": "123e4567-e89b-12d3-a456-426614174001",
        "locationId": "123e4567-e89b-12d3-a456-426614174002",
        "staffMemberId": "123e4567-e89b-12d3-a456-426614174003"
    },
    "notifyCustomer": True,
    "isManual": False,
    "address": {
        "addressLine1": "123 Main Street",
        "addressLine2": "Suite 456",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001",
        "country": "USA"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    slot: {
      fromDate: '2023-06-15',
      fromTime: '09:00:00',
      toDate: '2023-06-15',
      toTime: '10:00:00',
      productId: '123e4567-e89b-12d3-a456-426614174001',
      locationId: '123e4567-e89b-12d3-a456-426614174002',
      staffMemberId: '123e4567-e89b-12d3-a456-426614174003'
    },
    notifyCustomer: true,
    isManual: false,
    address: {
      addressLine1: '123 Main Street',
      addressLine2: 'Suite 456',
      city: 'New York',
      state: 'NY',
      postalCode: '10001',
      country: 'USA'
    }
  })
};

fetch('https://api.opencals.com/storefront/appointments/{appointmentId}/reschedule', 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://api.opencals.com/storefront/appointments/{appointmentId}/reschedule",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'slot' => [
        'fromDate' => '2023-06-15',
        'fromTime' => '09:00:00',
        'toDate' => '2023-06-15',
        'toTime' => '10:00:00',
        'productId' => '123e4567-e89b-12d3-a456-426614174001',
        'locationId' => '123e4567-e89b-12d3-a456-426614174002',
        'staffMemberId' => '123e4567-e89b-12d3-a456-426614174003'
    ],
    'notifyCustomer' => true,
    'isManual' => false,
    'address' => [
        'addressLine1' => '123 Main Street',
        'addressLine2' => 'Suite 456',
        'city' => 'New York',
        'state' => 'NY',
        'postalCode' => '10001',
        'country' => 'USA'
    ]
  ]),
  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;
}

package main

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

func main() {

	url := "https://api.opencals.com/storefront/appointments/{appointmentId}/reschedule"

	payload := strings.NewReader("{\n  \"slot\": {\n    \"fromDate\": \"2023-06-15\",\n    \"fromTime\": \"09:00:00\",\n    \"toDate\": \"2023-06-15\",\n    \"toTime\": \"10:00:00\",\n    \"productId\": \"123e4567-e89b-12d3-a456-426614174001\",\n    \"locationId\": \"123e4567-e89b-12d3-a456-426614174002\",\n    \"staffMemberId\": \"123e4567-e89b-12d3-a456-426614174003\"\n  },\n  \"notifyCustomer\": true,\n  \"isManual\": false,\n  \"address\": {\n    \"addressLine1\": \"123 Main Street\",\n    \"addressLine2\": \"Suite 456\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"postalCode\": \"10001\",\n    \"country\": \"USA\"\n  }\n}")

	req, _ := http.NewRequest("PUT", 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))

}

HttpResponse<String> response = Unirest.put("https://api.opencals.com/storefront/appointments/{appointmentId}/reschedule")
  .header("Content-Type", "application/json")
  .body("{\n  \"slot\": {\n    \"fromDate\": \"2023-06-15\",\n    \"fromTime\": \"09:00:00\",\n    \"toDate\": \"2023-06-15\",\n    \"toTime\": \"10:00:00\",\n    \"productId\": \"123e4567-e89b-12d3-a456-426614174001\",\n    \"locationId\": \"123e4567-e89b-12d3-a456-426614174002\",\n    \"staffMemberId\": \"123e4567-e89b-12d3-a456-426614174003\"\n  },\n  \"notifyCustomer\": true,\n  \"isManual\": false,\n  \"address\": {\n    \"addressLine1\": \"123 Main Street\",\n    \"addressLine2\": \"Suite 456\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"postalCode\": \"10001\",\n    \"country\": \"USA\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.opencals.com/storefront/appointments/{appointmentId}/reschedule")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"slot\": {\n    \"fromDate\": \"2023-06-15\",\n    \"fromTime\": \"09:00:00\",\n    \"toDate\": \"2023-06-15\",\n    \"toTime\": \"10:00:00\",\n    \"productId\": \"123e4567-e89b-12d3-a456-426614174001\",\n    \"locationId\": \"123e4567-e89b-12d3-a456-426614174002\",\n    \"staffMemberId\": \"123e4567-e89b-12d3-a456-426614174003\"\n  },\n  \"notifyCustomer\": true,\n  \"isManual\": false,\n  \"address\": {\n    \"addressLine1\": \"123 Main Street\",\n    \"addressLine2\": \"Suite 456\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"postalCode\": \"10001\",\n    \"country\": \"USA\"\n  }\n}"

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "1001",
  "productId": "123e4567-e89b-12d3-a456-426614174001",
  "staffMemberId": "123e4567-e89b-12d3-a456-426614174002",
  "locationId": "123e4567-e89b-12d3-a456-426614174003",
  "storeId": "123e4567-e89b-12d3-a456-426614174004",
  "customerId": "123e4567-e89b-12d3-a456-426614174005",
  "externalOrderId": "12345678",
  "externalOrderName": "#1001",
  "from": "2023-06-15T09:00:00Z",
  "to": "2023-06-15T10:00:00Z",
  "addressLine1": "123 Main Street",
  "addressLine2": "Suite 456",
  "city": "New York",
  "state": "NY",
  "postalCode": "10001",
  "country": "USA",
  "status": "scheduled",
  "internalNote": "Customer requested extra attention for specific needs",
  "createdBy": "customer",
  "reminderSentAt": "2023-06-14T09:00:00Z",
  "numberOfAttendees": 1,
  "createdAt": "2023-06-01T10:30:00Z",
  "updatedAt": "2023-06-02T14:15:00Z",
  "deletedAt": "2023-06-03T09:45:00Z",
  "product": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "externalId": "1234567890",
    "externalVariantId": "9876543210",
    "storeId": "123e4567-e89b-12d3-a456-426614174001",
    "slug": "haircut-basic",
    "scheduleId": "<string>",
    "productPoolId": "<string>",
    "title": "Haircut Service",
    "variantTitle": "Short Hair",
    "description": "<string>",
    "imageId": "<string>",
    "color": "BLUE",
    "price": 250,
    "taxable": false,
    "duration": 3600,
    "allowCustomDuration": false,
    "maxDuration": -1,
    "maxAttendees": 1,
    "maxGuests": 123,
    "allowGuests": false,
    "allowCustomerReschedule": false,
    "allowCustomerCancel": false,
    "rescheduleGap": 123,
    "cancelGap": 123,
    "beforeGap": 123,
    "afterGap": 123,
    "fixedTimes": false,
    "fixedStartTime": "09:00:00",
    "fixedEndTime": "17:00:00",
    "advanceScheduleThreshold": 0,
    "sendConfirmationEmail": true,
    "sendReminderEmail": false,
    "sendFeedbackEmail": false,
    "skipCheckout": false,
    "status": "ACTIVE",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "image": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalId": "img_123456",
      "url": "https://storage.example.com/images/product-image.jpg",
      "filename": "product-image.jpg",
      "mime": "image/jpeg",
      "createdAt": "2023-01-01T12:00:00Z",
      "updatedAt": "2023-01-02T12:00:00Z",
      "deletedAt": "2023-01-03T12:00:00Z",
      "storeId": "store-uuid"
    }
  },
  "staffMember": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "storeId": "123e4567-e89b-12d3-a456-426614174111",
    "userId": "user-uuid",
    "scheduleId": "123e4567-e89b-12d3-a456-426614174000",
    "imageId": "123e4567-e89b-12d3-a456-426614174000",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "slug": "mike",
    "refreshToken": "abc123xyz456",
    "createdAt": "2025-05-01T12:00:00Z",
    "updatedAt": "2025-05-15T14:30:00Z",
    "deletedAt": "2025-06-01T09:15:00Z",
    "image": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalId": "img_123456",
      "url": "https://storage.example.com/images/product-image.jpg",
      "filename": "product-image.jpg",
      "mime": "image/jpeg",
      "createdAt": "2023-01-01T12:00:00Z",
      "updatedAt": "2023-01-02T12:00:00Z",
      "deletedAt": "2023-01-03T12:00:00Z",
      "storeId": "store-uuid"
    }
  },
  "location": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "storeId": "123e4567-e89b-12d3-a456-426614174001",
    "scheduleId": "123e4567-e89b-12d3-a456-426614174002",
    "title": "Main Office",
    "description": "Our main downtown office location with 3 treatment rooms",
    "slug": "new-york",
    "type": "physical",
    "link": "https://zoom.us/j/123456789",
    "addressLine1": "123 Main Street",
    "addressLine2": "Suite 200",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94105",
    "country": "United States",
    "addressPlaceId": "ChIJIQBpAG2ahYAR_6128GcTUEo",
    "latitude": 37.4224764,
    "longitude": -122.0842499,
    "createdAt": "2023-01-20T08:30:00Z",
    "updatedAt": "2023-02-15T14:20:00Z",
    "deletedAt": "2023-03-10T11:45:00Z",
    "address": "<string>"
  },
  "addOns": [
    {
      "id": "<string>",
      "appointmentId": "<string>",
      "addOnId": "<string>",
      "quantity": 1,
      "createdAt": "2023-11-07T05:31:56Z",
      "addOn": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalId": "1234567890",
        "externalVariantId": "9876543210",
        "storeId": "123e4567-e89b-12d3-a456-426614174001",
        "slug": "child-seat",
        "title": "Child Seat",
        "description": "<string>",
        "imageId": "<string>",
        "color": "slate",
        "price": 15,
        "taxable": true,
        "durationMultiplied": false,
        "maxQuantity": 4,
        "status": "active",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "deletedAt": "<string>",
        "image": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "externalId": "img_123456",
          "url": "https://storage.example.com/images/product-image.jpg",
          "filename": "product-image.jpg",
          "mime": "image/jpeg",
          "createdAt": "2023-01-01T12:00:00Z",
          "updatedAt": "2023-01-02T12:00:00Z",
          "deletedAt": "2023-01-03T12:00:00Z",
          "storeId": "store-uuid"
        }
      }
    }
  ],
  "guests": [
    {
      "email": "guest@example.com"
    }
  ]
}

PUT

storefront

appointments

{appointmentId}

reschedule

Reschedule appointment

curl --request PUT \
  --url https://api.opencals.com/storefront/appointments/{appointmentId}/reschedule \
  --header 'Content-Type: application/json' \
  --data '
{
  "slot": {
    "fromDate": "2023-06-15",
    "fromTime": "09:00:00",
    "toDate": "2023-06-15",
    "toTime": "10:00:00",
    "productId": "123e4567-e89b-12d3-a456-426614174001",
    "locationId": "123e4567-e89b-12d3-a456-426614174002",
    "staffMemberId": "123e4567-e89b-12d3-a456-426614174003"
  },
  "notifyCustomer": true,
  "isManual": false,
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Suite 456",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "USA"
  }
}
'

import requests

url = "https://api.opencals.com/storefront/appointments/{appointmentId}/reschedule"

payload = {
    "slot": {
        "fromDate": "2023-06-15",
        "fromTime": "09:00:00",
        "toDate": "2023-06-15",
        "toTime": "10:00:00",
        "productId": "123e4567-e89b-12d3-a456-426614174001",
        "locationId": "123e4567-e89b-12d3-a456-426614174002",
        "staffMemberId": "123e4567-e89b-12d3-a456-426614174003"
    },
    "notifyCustomer": True,
    "isManual": False,
    "address": {
        "addressLine1": "123 Main Street",
        "addressLine2": "Suite 456",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001",
        "country": "USA"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    slot: {
      fromDate: '2023-06-15',
      fromTime: '09:00:00',
      toDate: '2023-06-15',
      toTime: '10:00:00',
      productId: '123e4567-e89b-12d3-a456-426614174001',
      locationId: '123e4567-e89b-12d3-a456-426614174002',
      staffMemberId: '123e4567-e89b-12d3-a456-426614174003'
    },
    notifyCustomer: true,
    isManual: false,
    address: {
      addressLine1: '123 Main Street',
      addressLine2: 'Suite 456',
      city: 'New York',
      state: 'NY',
      postalCode: '10001',
      country: 'USA'
    }
  })
};

fetch('https://api.opencals.com/storefront/appointments/{appointmentId}/reschedule', 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://api.opencals.com/storefront/appointments/{appointmentId}/reschedule",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'slot' => [
        'fromDate' => '2023-06-15',
        'fromTime' => '09:00:00',
        'toDate' => '2023-06-15',
        'toTime' => '10:00:00',
        'productId' => '123e4567-e89b-12d3-a456-426614174001',
        'locationId' => '123e4567-e89b-12d3-a456-426614174002',
        'staffMemberId' => '123e4567-e89b-12d3-a456-426614174003'
    ],
    'notifyCustomer' => true,
    'isManual' => false,
    'address' => [
        'addressLine1' => '123 Main Street',
        'addressLine2' => 'Suite 456',
        'city' => 'New York',
        'state' => 'NY',
        'postalCode' => '10001',
        'country' => 'USA'
    ]
  ]),
  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;
}

package main

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

func main() {

	url := "https://api.opencals.com/storefront/appointments/{appointmentId}/reschedule"

	payload := strings.NewReader("{\n  \"slot\": {\n    \"fromDate\": \"2023-06-15\",\n    \"fromTime\": \"09:00:00\",\n    \"toDate\": \"2023-06-15\",\n    \"toTime\": \"10:00:00\",\n    \"productId\": \"123e4567-e89b-12d3-a456-426614174001\",\n    \"locationId\": \"123e4567-e89b-12d3-a456-426614174002\",\n    \"staffMemberId\": \"123e4567-e89b-12d3-a456-426614174003\"\n  },\n  \"notifyCustomer\": true,\n  \"isManual\": false,\n  \"address\": {\n    \"addressLine1\": \"123 Main Street\",\n    \"addressLine2\": \"Suite 456\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"postalCode\": \"10001\",\n    \"country\": \"USA\"\n  }\n}")

	req, _ := http.NewRequest("PUT", 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))

}

HttpResponse<String> response = Unirest.put("https://api.opencals.com/storefront/appointments/{appointmentId}/reschedule")
  .header("Content-Type", "application/json")
  .body("{\n  \"slot\": {\n    \"fromDate\": \"2023-06-15\",\n    \"fromTime\": \"09:00:00\",\n    \"toDate\": \"2023-06-15\",\n    \"toTime\": \"10:00:00\",\n    \"productId\": \"123e4567-e89b-12d3-a456-426614174001\",\n    \"locationId\": \"123e4567-e89b-12d3-a456-426614174002\",\n    \"staffMemberId\": \"123e4567-e89b-12d3-a456-426614174003\"\n  },\n  \"notifyCustomer\": true,\n  \"isManual\": false,\n  \"address\": {\n    \"addressLine1\": \"123 Main Street\",\n    \"addressLine2\": \"Suite 456\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"postalCode\": \"10001\",\n    \"country\": \"USA\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.opencals.com/storefront/appointments/{appointmentId}/reschedule")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"slot\": {\n    \"fromDate\": \"2023-06-15\",\n    \"fromTime\": \"09:00:00\",\n    \"toDate\": \"2023-06-15\",\n    \"toTime\": \"10:00:00\",\n    \"productId\": \"123e4567-e89b-12d3-a456-426614174001\",\n    \"locationId\": \"123e4567-e89b-12d3-a456-426614174002\",\n    \"staffMemberId\": \"123e4567-e89b-12d3-a456-426614174003\"\n  },\n  \"notifyCustomer\": true,\n  \"isManual\": false,\n  \"address\": {\n    \"addressLine1\": \"123 Main Street\",\n    \"addressLine2\": \"Suite 456\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"postalCode\": \"10001\",\n    \"country\": \"USA\"\n  }\n}"

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "1001",
  "productId": "123e4567-e89b-12d3-a456-426614174001",
  "staffMemberId": "123e4567-e89b-12d3-a456-426614174002",
  "locationId": "123e4567-e89b-12d3-a456-426614174003",
  "storeId": "123e4567-e89b-12d3-a456-426614174004",
  "customerId": "123e4567-e89b-12d3-a456-426614174005",
  "externalOrderId": "12345678",
  "externalOrderName": "#1001",
  "from": "2023-06-15T09:00:00Z",
  "to": "2023-06-15T10:00:00Z",
  "addressLine1": "123 Main Street",
  "addressLine2": "Suite 456",
  "city": "New York",
  "state": "NY",
  "postalCode": "10001",
  "country": "USA",
  "status": "scheduled",
  "internalNote": "Customer requested extra attention for specific needs",
  "createdBy": "customer",
  "reminderSentAt": "2023-06-14T09:00:00Z",
  "numberOfAttendees": 1,
  "createdAt": "2023-06-01T10:30:00Z",
  "updatedAt": "2023-06-02T14:15:00Z",
  "deletedAt": "2023-06-03T09:45:00Z",
  "product": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "externalId": "1234567890",
    "externalVariantId": "9876543210",
    "storeId": "123e4567-e89b-12d3-a456-426614174001",
    "slug": "haircut-basic",
    "scheduleId": "<string>",
    "productPoolId": "<string>",
    "title": "Haircut Service",
    "variantTitle": "Short Hair",
    "description": "<string>",
    "imageId": "<string>",
    "color": "BLUE",
    "price": 250,
    "taxable": false,
    "duration": 3600,
    "allowCustomDuration": false,
    "maxDuration": -1,
    "maxAttendees": 1,
    "maxGuests": 123,
    "allowGuests": false,
    "allowCustomerReschedule": false,
    "allowCustomerCancel": false,
    "rescheduleGap": 123,
    "cancelGap": 123,
    "beforeGap": 123,
    "afterGap": 123,
    "fixedTimes": false,
    "fixedStartTime": "09:00:00",
    "fixedEndTime": "17:00:00",
    "advanceScheduleThreshold": 0,
    "sendConfirmationEmail": true,
    "sendReminderEmail": false,
    "sendFeedbackEmail": false,
    "skipCheckout": false,
    "status": "ACTIVE",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "image": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalId": "img_123456",
      "url": "https://storage.example.com/images/product-image.jpg",
      "filename": "product-image.jpg",
      "mime": "image/jpeg",
      "createdAt": "2023-01-01T12:00:00Z",
      "updatedAt": "2023-01-02T12:00:00Z",
      "deletedAt": "2023-01-03T12:00:00Z",
      "storeId": "store-uuid"
    }
  },
  "staffMember": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "storeId": "123e4567-e89b-12d3-a456-426614174111",
    "userId": "user-uuid",
    "scheduleId": "123e4567-e89b-12d3-a456-426614174000",
    "imageId": "123e4567-e89b-12d3-a456-426614174000",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "slug": "mike",
    "refreshToken": "abc123xyz456",
    "createdAt": "2025-05-01T12:00:00Z",
    "updatedAt": "2025-05-15T14:30:00Z",
    "deletedAt": "2025-06-01T09:15:00Z",
    "image": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalId": "img_123456",
      "url": "https://storage.example.com/images/product-image.jpg",
      "filename": "product-image.jpg",
      "mime": "image/jpeg",
      "createdAt": "2023-01-01T12:00:00Z",
      "updatedAt": "2023-01-02T12:00:00Z",
      "deletedAt": "2023-01-03T12:00:00Z",
      "storeId": "store-uuid"
    }
  },
  "location": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "storeId": "123e4567-e89b-12d3-a456-426614174001",
    "scheduleId": "123e4567-e89b-12d3-a456-426614174002",
    "title": "Main Office",
    "description": "Our main downtown office location with 3 treatment rooms",
    "slug": "new-york",
    "type": "physical",
    "link": "https://zoom.us/j/123456789",
    "addressLine1": "123 Main Street",
    "addressLine2": "Suite 200",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94105",
    "country": "United States",
    "addressPlaceId": "ChIJIQBpAG2ahYAR_6128GcTUEo",
    "latitude": 37.4224764,
    "longitude": -122.0842499,
    "createdAt": "2023-01-20T08:30:00Z",
    "updatedAt": "2023-02-15T14:20:00Z",
    "deletedAt": "2023-03-10T11:45:00Z",
    "address": "<string>"
  },
  "addOns": [
    {
      "id": "<string>",
      "appointmentId": "<string>",
      "addOnId": "<string>",
      "quantity": 1,
      "createdAt": "2023-11-07T05:31:56Z",
      "addOn": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalId": "1234567890",
        "externalVariantId": "9876543210",
        "storeId": "123e4567-e89b-12d3-a456-426614174001",
        "slug": "child-seat",
        "title": "Child Seat",
        "description": "<string>",
        "imageId": "<string>",
        "color": "slate",
        "price": 15,
        "taxable": true,
        "durationMultiplied": false,
        "maxQuantity": 4,
        "status": "active",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "deletedAt": "<string>",
        "image": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "externalId": "img_123456",
          "url": "https://storage.example.com/images/product-image.jpg",
          "filename": "product-image.jpg",
          "mime": "image/jpeg",
          "createdAt": "2023-01-01T12:00:00Z",
          "updatedAt": "2023-01-02T12:00:00Z",
          "deletedAt": "2023-01-03T12:00:00Z",
          "storeId": "store-uuid"
        }
      }
    }
  ],
  "guests": [
    {
      "email": "guest@example.com"
    }
  ]
}

Path Parameters

appointmentId

string

required

Appointment unique identifier

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json

New appointment time details

slot

object

required

Appointment slot information — date/time range with product, location, and staff

Show child attributes

notifyCustomer

boolean

default:true

Whether to send rescheduling notification to the customer

Example:

true

isManual

boolean

default:false

Indicates if the appointment was rescheduled manually instead of by the customer

Example:

false

address

object

Physical address where the appointment will take place

Show child attributes

Response

200 - application/json

The rescheduled appointment details

string

required

Unique identifier of the appointment

Example:

"123e4567-e89b-12d3-a456-426614174000"

name

string

required

Generated appointment name for the user (starts at 1001 and increments)

Example:

"1001"

productId

string

required

ID of the service/product for this appointment

Example:

"123e4567-e89b-12d3-a456-426614174001"

staffMemberId

string | null

required

ID of the staff member assigned to this appointment (if any)

Example:

"123e4567-e89b-12d3-a456-426614174002"

locationId

string | null

required

ID of the location where the appointment will take place (if any)

Example:

"123e4567-e89b-12d3-a456-426614174003"

storeId

string

required

ID of the store that owns this appointment

Example:

"123e4567-e89b-12d3-a456-426614174004"

customerId

string | null

required

ID of the customer who booked the appointment

Example:

"123e4567-e89b-12d3-a456-426614174005"

externalOrderId

string | null

required

External order ID from user's platform (if any)

Example:

"12345678"

externalOrderName

string | null

required

External order name/reference from user's platform

Example:

"#1001"

from

string<date-time>

required

Start date and time of the appointment (UTC timezone)

Example:

"2023-06-15T09:00:00Z"

string<date-time>

required

End date and time of the appointment (UTC timezone)

Example:

"2023-06-15T10:00:00Z"

addressLine1

string | null

required

First line of the appointment address

Example:

"123 Main Street"

addressLine2

string | null

required

Second line of the appointment address

Example:

"Suite 456"

city

string | null

required

City of the appointment location

Example:

"New York"

state

string | null

required

State/province of the appointment location

Example:

"NY"

postalCode

string | null

required

Postal/zip code of the appointment location

Example:

"10001"

country

string | null

required

Country of the appointment location

Example:

"USA"

status

enum<string>

default:pending

required

Current status of the appointment

Available options:

pending,

scheduled,

completed,

canceled

Example:

"scheduled"

internalNote

string | null

required

Internal notes about the appointment (not visible to customers)

Example:

"Customer requested extra attention for specific needs"

createdBy

enum<string>

default:customer

required

Indicates who created the appointment (customer or merchant)

Available options:

customer,

merchant

Example:

"customer"

reminderSentAt

string<date-time> | null

required

Date and time when reminder was sent to the customer

Example:

"2023-06-14T09:00:00Z"

numberOfAttendees

number

default:1

required

Number of people attending the appointment

Example:

1

createdAt

string<date-time>

required

Date and time when the appointment was created

Example:

"2023-06-01T10:30:00Z"

updatedAt

string<date-time> | null

required

Date and time when the appointment was last updated

Example:

"2023-06-02T14:15:00Z"

deletedAt

string<date-time> | null

required

Date and time when the appointment was soft-deleted

Example:

"2023-06-03T09:45:00Z"

product

object

required

Service/product details for this appointment

Show child attributes

staffMember

object | null

required

Staff member assigned to this appointment

Show child attributes

location

object | null

required

Location where the appointment will take place

Show child attributes

addOns

object[]

required

Add-ons attached to this appointment

Show child attributes

guests

object[]

required

Guests invited to this appointment (copied on notifications)

Show child attributes

Last modified on July 26, 2026

Get appointment by external order name Cancel appointment

Getting started

Endpoints

Reschedule appointment

Path Parameters

Body

Response