Skip to main content
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}}"
  }'

{
  "success": true,
  "details": "Schedule status updated"
}

Documentation Index

Fetch the complete documentation index at: https://docs.hookpulse.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

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}}"
  }'

​
Request body

FieldTypeRequiredDescription
schedule_uuidstringYesUUID of the schedule to update
update_status_tostringYesNew status: "active" or "paused"

​
Example response

{
  "success": true,
  "details": "Schedule status updated"
}

​
Response fields

FieldTypeDescription
successbooleanIndicates if the status was updated successfully
detailsstringSuccess message

​
Status Options

StatusDescription
"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

Authorizations

​
x-hookpulse-api-key
string
header
required

API key for authentication. Get this from your dashboard by selecting a brand and going to API Keys section.

​
x-brand-uuid
string
header
required

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

​
schedule_uuid
string
required

UUID of the schedule to update

​
update_status_to
enum<string>
required

New status: 'active' or 'paused'

Available options:
active,
paused

Response

Status updated successfully

​
success
boolean

Indicates if the status was updated successfully

​
details
string

Success message