PATCH/enrollments/{id}/pause

PATCH /enrollments/{id}/pause

Pause an active enrollment. The contact stops advancing but keeps its position.

View as Markdown

Request

curl -X PATCH 'https://api.sendheron.com/api/v1/enrollments/{id}/pause' \
  -H 'Authorization: Bearer <YOUR_API_KEY>' \
  -H 'Content-Type: application/json'

Required scopes

The key must carry these:

  • sequences:write

Path parameters

NameTypeRequiredDescription
iduuidYesEnrollment UUID.

Responses

Returns 200 on success. Errors use standard HTTP status codes: 401 for a missing or invalid key, 403 when the key lacks a required scope, 404 for an unknown id, and 429 when a rate limit window is exhausted.

Rate limits

60 per minute, 150 per 5 minutes, 300 per hour, 2000 per day. All windows apply at once, and the tightest one you breach is the one that rejects the request.