Skip to content

Stop records in a sequence​

POST
/api/nova/sequences/{sequenceId}/stop

Stops leads, contacts or candidates in a drip sequence, exactly as Stop on a member in the app does: every step not yet sent is cancelled and the member is marked Cancelled. The member and what was already sent stay on the record; nothing is deleted. The body takes recordType (LEAD, CONTACT, CANDIDATE or OPPORTUNITY; an opportunity is matched through its contact, as enrolment does) and recordIds (1 to 100 record ids or references such as LD-10577). Works on any sequence, including disabled and archived ones. A record that is not stopped is reported with its reason (NOT_FOUND, NOT_ENROLLED, ALREADY_STOPPED, NOTHING_PENDING when every step has already been sent, NO_CONTACT for an opportunity without a contact, DUPLICATE for a record named twice) alongside requested, stopped and skipped counts. Returns 404 if the sequence is not found, 400 if recordType or recordIds is invalid, and 401 if the API key is invalid.

Authorizations​

privateApiKey
Type
API Key (query: apiKey)

Parameters​

Path Parameters

sequenceId*

sequenceId

Type
string
Required

Query Parameters

apiKey*

apiKey

Type
string
Required

Request Body​

application/json
JSON
{
  
"recordIds": [
  
  
"string"
  
],
  
"recordType": "string"
}

Responses​

OK

application/json
JSON
{
  
"data": {
  
},
  
"error": "string",
  
"message": "string",
  
"requestId": "string",
  
"success": true
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Recruitly — Recruitment CRM for Agencies