Skip to main content
POST
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:

Example request

Request body

Example response

Response fields

Status Options

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

Pause a Schedule

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