Skip to content
Norbelys
Esc
↑↓navigate↵open⌘Jpreview

Stop an enrollment: no further step runs, and its message still queued is cancelled.

POST/v1/enrollments/{id}/stop
Authorization
AuthorizationBearer token · headerrequired

An API key (nb_live_…, nb_test_…), a workspace token (nbs_…) or a CLI token (nbc_…).

Path parameters
idId_Enrollmentrequired

The enrollment id (enr_…).

matches ^enr_[0-9a-f]{32}$
Header parameters
Idempotency-Keystringrequired

A stable key for this logical request; reuse it when retrying.

min length 1 · max length 128 · matches ^[!-~]+$
Responses
200

The enrollment, stopped.

campaign_idId_Campaignrequired
matches ^cmp_[0-9a-f]{32}$
created_atTimestamprequired
idId_Enrollmentrequired
matches ^enr_[0-9a-f]{32}$
message_idId_Message | null
Show properties
One of:
Id_Message
string
null
null
next_run_atTimestamp | null
Show properties
One of:
Timestamp
string<date-time>
null
null
personPersonRefrequired

The person an enrollment is for.

Show properties
emailstringrequired
idId_Personrequired
matches ^per_[0-9a-f]{32}$
namestring | null

The given and family names, when the person has either.

positioninteger<int32>required

The step it is at, 1 for the first.

sender_identity_idId_SenderIdentity | null
Show properties
One of:
Id_SenderIdentity
string
null
null
statusEnrollmentStatusrequired

An enrollment's lifecycle (enrollments.status).

Allowed:activepausedcompletedrepliedstoppedfailed
status_detailstring | null

Why it ended, when it ended early.

updated_atTimestamprequired
waiting_forId_SenderIdentity | null
Show properties
One of:
Id_SenderIdentity
string
null
null
401

No valid credential.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

403

The credential lacks campaigns:write.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

404

No such enrollment in this workspace.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

409

The enrollment already ended (invalid_state).

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

Try it
Server
Authorization
Parameters
Request
curl -X POST 'https://api.norbelys.com/v1/enrollments/enr_0190f8a2b4c87a10b6d2e4f6a8c0e2f4/stop' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Idempotency-Key: string'
Response
{
  "campaign_id": "cmp_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
  "created_at": "2019-08-24T14:15:22Z",
  "id": "enr_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
  "message_id": "msg_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
  "next_run_at": "2019-08-24T14:15:22Z",
  "person": {
    "email": "string",
    "id": "per_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
    "name": "string"
  },
  "position": 0,
  "sender_identity_id": "sid_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
  "status": "active",
  "status_detail": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "waiting_for": "sid_0190f8a2b4c87a10b6d2e4f6a8c0e2f4"
}