Skip to main content
PATCH
Update campaign status

Authorizations

X-Api-Key
string
header
required

API key (hr_live_... or hr_test_...). Generate from Settings › Workspace › Acceso API.

Path Parameters

id
string
required

Body

application/json
status
enum<string>
required

New campaign status. Use running to start a campaign and begin scheduled extractions/outreach. Use paused to temporarily suspend it without losing configuration. draft and completed are managed by the system.

Available options:
draft,
running,
paused,
completed
Example:

"running"

Response

200 - undefined