Canceling an appointment keeps a record of the appointment and amends the status to Canceled. Canceling is different from deleting an appointment which will completely erase the appointment from the Setster database.

The steps to cancel an appointment are as follows:

1. Make a GET request to List Appointments to retrieve appointments - You may wish to include a client email, or client ID o narrow the appointments to a specific user.
2. Locate the appointment you would like to cancel from the list of appointments in the response body.
3. Take note of the appointment's id for later use.
4. To cancel, you'll need to update the appointment's status to "status": 3. The complete list of appointment status codes are listed below.
5. Finally, you're ready to make a PUT request to the Modify Appointment Endpoint to update the appointment status to 3 - completing the appointment cancellation process.

After completing the previous steps you should make a PUT request to the https://www.setster.com/api/v2/appointment/{id}?session_token=SESSION_TOKEN&company_id=COMPANY_ID&id=ID replacing the id path parameter with the appointment id.

{
  "status": 3, // Status code 3 to cancel appointment
  "company_id": "{{company_id}}",
  "client_email": "<string>",
  "client_name": "<string>",
  "service_id": "<integer>",
  "start_date": "<integer>",
  "client_phone": "<string>",
  "client_address": "<string>",
  "employee_id": "<long>",
  "location_id": "<long>",
  "duration": 15,
  "note": "<string>",
  "subservices": "<integer>",
  "paid": false,
  "price": 0,
  "custom_data": "<object>",
  "timezone_id": "<integer>"
}

Rescheduling is moving an appointment to a different date, time, location, or service. A PUT is used to edit the parameters of an existing appointment.

Steps to reschedule an appointment:

1. Make a GET request to List Appointments to retrieve appointments - You may wish to include a client email, or client ID o narrow the appointments to a specific user.
2. Locate the appointment you would like to update from the list of appointments in the response body.
3. Take note of the appointment id, service_id, and other parameters for later use.
4. Make a GET request to Get Availability of the appointment's selected service by including the service_id you previously noted.
5. Once you've found the desired available date and time, take note of the day, month, year, and time.
6. Construct the start_date that will be used in the next request by combining the day, month, year, and time into a string formatted as "yyyy-mm-dd hh:mm:ss". For example: 2019-09-01 12:00
7. Finally, you're ready to make a PUT request to the Modify Appointment Endpoint to update the appointment time - completing the rescheduling process.

After completing the previous steps you should make a PUT request to the https://www.setster.com/api/v2/appointment/{id}?session_token=SESSION_TOKEN&company_id=COMPANY_ID&id=ID replacing the id path parameter with the appointment id.

{
  "company_id": "{{company_id}}",
  "client_email": "<string>",
  "client_name": "<string>",
  "service_id": "{{service_id}}",
  "start_date": "{{start_date}}",
  "client_phone": "<string>",
  "client_address": "<string>",
  "employee_id": "<long>",
  "location_id": "<long>",
  "duration": 15,
  "note": "<string>",
  "subservices": "<string>",
  "paid": false,
  "price": 0,
  "custom_data": "<object>",
  "timezone_id": "<integer>"
}

Modify appointment to cancel it.