Appearance
Enrol records in a sequence
POST
/api/nova/sequences/{sequenceId}/enrol
Adds leads, contacts or candidates to a drip sequence, exactly as enrolling them from the app does. The body takes recordType (LEAD, CONTACT, CANDIDATE or OPPORTUNITY; it must match the sequence's type unless that is ALL), recordIds (1 to 100 record ids or references such as LD-10577). An opportunity is enrolled through its contact, as in the app, and who the emails send from: senderId or senderEmail names one of the account's registered Email Senders, and leaving both blank sends from the connected mailbox of the user who owns the API key. jobId is optional and fills job and interview merge tags for sequences that use them. A record already in the sequence, one that cannot be found, or one without an email address (when the sequence sends email) is skipped, never enrolled twice; the response lists each skipped record with its reason (ALREADY_ENROLLED, NOT_FOUND, NO_EMAIL, NO_CONTACT for an opportunity without a contact, DUPLICATE for a record named twice) alongside requested, enrolled and skipped counts. Sequences with SMS or WhatsApp steps are refused, because those need a sending number or device chosen at enrolment; use the app or an automation for them (the list endpoint's sendSMS and sendWhatsApp flags say which). Returns 404 if the sequence is not found, 400 if the sequence is a draft, archived, disabled or has SMS or WhatsApp steps, if recordType does not match the sequence, if the sender is unknown or cannot be used for automated sending, or if the account's marketing email credit or spending limit blocks the enrolment, and 401 if the API key is invalid.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
sequenceId*
sequenceId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "jobId": "string", "recordIds": [ "string" ], "recordType": "string", "senderEmail": "string", "senderId": "string"
{
}
Responses
OK
application/json
JSON "data": { }, "error": "string", "message": "string", "requestId": "string", "success": true
{
}