POST

Appointments.Delete

Cancel (default) or hard-delete a staff CRM doctor appointment via delete_doctor_appointment_for_cust_api. Soft cancel sets cancle_status. Pass hard_delete=1 or is_cancle_delete=delete for hard delete. Aliases: Appointments.Remove, Appointments.Cancel.

Permissions

User must be logged in with a valid bearer token.
The user must be from the same company domain as the request Host (call the API on that account subdomain or allowed custom domain). A token from another company returns success=0, error user_not_in_company.
Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

Removes the requested Appointments record when the user has permission.

Push Service

No push is sent because this function only reads data or returns helper information.

Automation

No automation is run for this function.

Special Instructions

On a company subdomain (e.g. https://{user_domain}.bull36.com) the user must match that Host — Login and protected APIs reject another company with success=0, error user_not_in_company. On a main brand host (bull36.com, biz1.co.il, mastrocrm.com, …) the company domain gate is skipped.
Staff token required. Default is soft cancel (is_cancle_delete=cancle), matching dashboard.
Customer portal delete remains Customer.Appointments.Delete.

Required Parameters

Name	Type	Sample	Explanation
`id` post	int	`6550636`	Appointment id. Aliases: data_id, appointment_id.

Optional Parameters

Name	Type	Sample	What it gives
`hard_delete` post	int	`0`	1 = hard delete. Alias: appointment_is_delete.
`is_cancle_delete` post	string	`cancle`	cancle (default) or delete.
`delete_all_future_appointments` post	int	`0`	1 = also remove future linked appointments when supported.

Authentication

Send the bearer token returned by Login in the request header. The user must be from the same company domain as this Host — a token from another company is rejected (user_not_in_company).

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Appointments.Delete",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "id": "6550636"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Appointments.Delete",
    "url_domain": "https:\/\/{domain}\/app\/Appointments.Delete"
}

Endpoint

POST /app/Appointments.Delete
POST https://{user}.bull36.com/app/Appointments.Delete
POST https://{domain}/app/Appointments.Delete

Sample Output

{
    "success": 1,
    "message": "Success"
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('id', '6550636');

const res = await fetch('/app/Appointments.Delete', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "message": "Please select Appointment"
}