Pause, resume or remove one contact

PATCHhttps://api.norreach.app/v1/enrollments/{id}

pause holds one contact; resume lets them carry on (a contact parked on a send that didn't go out tries that step again); exit takes them out of the campaign (as the leads list's Remove — they may be enrolled again later). A resume never side-steps another door: a send waiting for approval is decided in Approvals, a contact held because the campaign isn't running carries on when it is resumed, one without a lawful basis needs consent first (409 each), and nothing resumes while outreach is paused.

⚠ campaigns:launchRole must allow: campaigns.launchIdempotency-Key requiredSupports dry_runOperation id: update_enrollment

PATCH/enrollments/{id}

curl -X PATCH "https://api.norreach.app/v1/enrollments/{id}" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "resume"
}'

Pause, resume or remove one contact

{
  "object": "enrollment_change",
  "id": "8e9f0a1b-2c3d-4e4f-9a5b-6c7d8e9f0a1b",
  "action": "resume",
  "from": "paused",
  "state": "active",
  "changed": true,
  "dry_run": false,
  "note": null
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope campaigns:launch. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Query parameters

dry_runbooleanquery

Run every check and return what would happen, changing nothing.

Headers

Idempotency-Keystringheaderrequired

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Body

application/json

actionenumrequired

One of:pauseresumeexit

Response

200application/json— Pause, resume or remove one contact

object"enrollment_change"required

idstring (uuid)required

An id (UUID).

actionenumrequired

One of:pauseresumeexit

fromstringrequired

statestringrequired

The state now (removed after an exit).

changedbooleanrequired

dry_runbooleanrequired

notestring | nullrequired

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
400	`idempotency_key_required`	This operation needs an Idempotency-Key header.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
403	`role_forbidden`	The key's creator's role can't do this.
404	`not_found`	That doesn't exist.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
409	`conflict`	That conflicts with the current state.
409	`outreach_paused`	Outreach is paused for this workspace.
413	`too_large`	The request body is too large.
422	`validation_failed`	The request has invalid fields.
422	`idempotency_mismatch`	This Idempotency-Key was used with a different request.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

PATCH/enrollments/{id}

curl -X PATCH "https://api.norreach.app/v1/enrollments/{id}" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "resume"
}'

Pause, resume or remove one contact

{
  "object": "enrollment_change",
  "id": "8e9f0a1b-2c3d-4e4f-9a5b-6c7d8e9f0a1b",
  "action": "resume",
  "from": "paused",
  "state": "active",
  "changed": true,
  "dry_run": false,
  "note": null
}