Sign in

v1

latestOpenAPI 3.0.02026-08-061280285.2 KB
Sequence APIs

Add prospects to a sequence.

<br/>Enrols one or more prospects (candidates or contacts) into an existing<br/>sequence and launches the sequence for the newly added recipients.<br/><br/>All prospect_ids must match the sequence's type (a Candidate sequence<br/>accepts only candidates, a Contact sequence only contacts). Because the API<br/>key is account-scoped rather than user-scoped, user_id is required and<br/>identifies the user recorded as performing the action; it must belong to<br/>your account.<br/><br/>Prospects that are already enrolled (or whose launch fails) are reported<br/>under recipient_failures rather than being re-added.<br/>

post/api/external/sequences/recipients/add

Headers

RF-Api-Keystring
content-typestring

Request body

prospect_idsinteger[] required

Ids of the candidates/contacts to enrol.

sequence_idinteger required

Id of the sequence to add recipients to.

user_idinteger required

Id of the user performing the action (must be in your account).

Example request

{
  "prospect_ids": [
    430489,
    430490
  ],
  "sequence_id": 42,
  "user_id": 3264
}

Response

Recipients processed

{"stackTrail":"paths:/api/external/sequences/recipients/add:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"RESULT":"SUCCESS","added_count":1,"recipient_failures":[]}}

Example response

{
  "RESULT": "SUCCESS",
  "added_count": 1,
  "recipient_failures": []
}