curl -X POST "https://api.hookpulse.io/v1/api/change_schedule_status/" \
-H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
-H "x-brand-uuid: {{x-brand-uuid}}" \
-H "Content-Type: application/json" \
-d '{
"schedule_uuid": "{{schedule_uuid}}",
"update_status_to": "{{update_status_to}}"
}'
const response = await fetch('https://api.hookpulse.io/v1/api/change_schedule_status/', {
method: 'POST',
headers: {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
schedule_uuid: '{{schedule_uuid}}',
update_status_to: '{{update_status_to}}'
})
});
const data = await response.json();
console.log(data);
import requests
url = 'https://api.hookpulse.io/v1/api/change_schedule_status/'
headers = {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
}
payload = {
'schedule_uuid': '{{schedule_uuid}}',
'update_status_to': '{{update_status_to}}'
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())
require 'net/http'
require 'json'
require 'uri'
uri = URI('https://api.hookpulse.io/v1/api/change_schedule_status/')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['x-hookpulse-api-key'] = '{{x-hookpulse-api-key}}'
request['x-brand-uuid'] = '{{x-brand-uuid}}'
request['Content-Type'] = 'application/json'
request.body = {
schedule_uuid: '{{schedule_uuid}}',
update_status_to: '{{update_status_to}}'
}.to_json
response = http.request(request)
puts JSON.parse(response.body)
<?php
$url = "https://api.hookpulse.io/v1/api/change_schedule_status/";
$data = [
'schedule_uuid' => '{{schedule_uuid}}',
'update_status_to' => '{{update_status_to}}'
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'x-hookpulse-api-key: {{x-hookpulse-api-key}}',
'x-brand-uuid: {{x-brand-uuid}}',
'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
{
"success": true,
"details": "Schedule status updated"
}
Scheduling
Change Schedule Status
Update the status of an existing schedule. Use this endpoint to activate or pause a schedule without deleting it
POST
/
v1
/
api
/
change_schedule_status
/
curl -X POST "https://api.hookpulse.io/v1/api/change_schedule_status/" \
-H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
-H "x-brand-uuid: {{x-brand-uuid}}" \
-H "Content-Type: application/json" \
-d '{
"schedule_uuid": "{{schedule_uuid}}",
"update_status_to": "{{update_status_to}}"
}'
const response = await fetch('https://api.hookpulse.io/v1/api/change_schedule_status/', {
method: 'POST',
headers: {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
schedule_uuid: '{{schedule_uuid}}',
update_status_to: '{{update_status_to}}'
})
});
const data = await response.json();
console.log(data);
import requests
url = 'https://api.hookpulse.io/v1/api/change_schedule_status/'
headers = {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
}
payload = {
'schedule_uuid': '{{schedule_uuid}}',
'update_status_to': '{{update_status_to}}'
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())
require 'net/http'
require 'json'
require 'uri'
uri = URI('https://api.hookpulse.io/v1/api/change_schedule_status/')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['x-hookpulse-api-key'] = '{{x-hookpulse-api-key}}'
request['x-brand-uuid'] = '{{x-brand-uuid}}'
request['Content-Type'] = 'application/json'
request.body = {
schedule_uuid: '{{schedule_uuid}}',
update_status_to: '{{update_status_to}}'
}.to_json
response = http.request(request)
puts JSON.parse(response.body)
<?php
$url = "https://api.hookpulse.io/v1/api/change_schedule_status/";
$data = [
'schedule_uuid' => '{{schedule_uuid}}',
'update_status_to' => '{{update_status_to}}'
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'x-hookpulse-api-key: {{x-hookpulse-api-key}}',
'x-brand-uuid: {{x-brand-uuid}}',
'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
{
"success": true,
"details": "Schedule status updated"
}
Update the status of an existing schedule. Use this endpoint to activate or pause a schedule without deleting it.
Base URL
All API requests should be made to:https://api.hookpulse.io
Example request
curl -X POST "https://api.hookpulse.io/v1/api/change_schedule_status/" \
-H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
-H "x-brand-uuid: {{x-brand-uuid}}" \
-H "Content-Type: application/json" \
-d '{
"schedule_uuid": "{{schedule_uuid}}",
"update_status_to": "{{update_status_to}}"
}'
const response = await fetch('https://api.hookpulse.io/v1/api/change_schedule_status/', {
method: 'POST',
headers: {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
schedule_uuid: '{{schedule_uuid}}',
update_status_to: '{{update_status_to}}'
})
});
const data = await response.json();
console.log(data);
import requests
url = 'https://api.hookpulse.io/v1/api/change_schedule_status/'
headers = {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
}
payload = {
'schedule_uuid': '{{schedule_uuid}}',
'update_status_to': '{{update_status_to}}'
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())
require 'net/http'
require 'json'
require 'uri'
uri = URI('https://api.hookpulse.io/v1/api/change_schedule_status/')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['x-hookpulse-api-key'] = '{{x-hookpulse-api-key}}'
request['x-brand-uuid'] = '{{x-brand-uuid}}'
request['Content-Type'] = 'application/json'
request.body = {
schedule_uuid: '{{schedule_uuid}}',
update_status_to: '{{update_status_to}}'
}.to_json
response = http.request(request)
puts JSON.parse(response.body)
<?php
$url = "https://api.hookpulse.io/v1/api/change_schedule_status/";
$data = [
'schedule_uuid' => '{{schedule_uuid}}',
'update_status_to' => '{{update_status_to}}'
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'x-hookpulse-api-key: {{x-hookpulse-api-key}}',
'x-brand-uuid: {{x-brand-uuid}}',
'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
Request body
| Field | Type | Required | Description |
|---|---|---|---|
schedule_uuid | string | Yes | UUID of the schedule to update |
update_status_to | string | Yes | New status: "active" or "paused" |
Example response
{
"success": true,
"details": "Schedule status updated"
}
Response fields
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates if the status was updated successfully |
details | string | Success message |
Status Options
| Status | Description |
|---|---|
"active" | Schedule is running and will execute according to its configuration |
"paused" | Schedule is temporarily paused and will not execute |
Use Cases
- Activate Schedule: Change a paused or inactive schedule to active
- Pause Schedule: Temporarily stop a schedule without deleting it
- Schedule Management: Control schedule execution programmatically
- Maintenance: Pause schedules during maintenance windows
- Testing: Pause/activate schedules during testing phases
Examples
Activate a Schedule
{
"schedule_uuid": "81646be2-ae5f-49f8-b253-ce87fe73be63",
"update_status_to": "active"
}
Pause a Schedule
{
"schedule_uuid": "81646be2-ae5f-49f8-b253-ce87fe73be63",
"update_status_to": "paused"
}
Important Notes
- No Deletion: Changing status does not delete the schedule or its rules
- Immediate Effect: Status changes take effect immediately
- Paused Schedules: Paused schedules will not execute until activated again
- Active Schedules: Active schedules will resume execution according to their configuration
- Completed/Expired: You cannot change the status of completed or expired schedules
Related Documentation
- Scheduling Overview - Learn about scheduling types and status values
- Get Single Schedule Details - View current schedule status
- Get Active Schedules (Paginated) - Filter schedules by status
- Delete Schedule - Permanently delete a schedule
Authorizations
API key for authentication. Get this from your dashboard by selecting a brand and going to API Keys section.
Brand UUID for authentication. Get this from your dashboard after adding a brand - it will be displayed in the UI.
Body
application/json
Schedule status update configuration

