Skip to main content
POST
/
api
/
v2
/
schedules
/
{schedule_id}
/
pause
Pause a schedule
curl --request POST \
  --url https://agp.eu.hcompany.ai/api/v2/schedules/{schedule_id}/pause \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "<string>"
}
'
Pauses the schedule: automatic fires stop and next_run_times empties. The schedule can still be fired manually with Trigger. Returns the updated schedule object with paused: true.

​
Path parameters

​
schedule_id
string
required
The schedule’s id (UUID).

​
Request body

​
note
string
Optional note explaining why the schedule is paused (max 255 characters). Returned as pause_note.

​
Examples

curl -X POST "https://agp.eu.hcompany.ai/api/v2/schedules/9f8e7d6c-5b4a-4c3d-8e2f-1a0b9c8d7e6f/pause" \
  -H "Authorization: Bearer $HAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"note": "Paused during site maintenance"}'

​
Errors

StatusCause
404No schedule with this id in your organization.