Sign in

v1

latestOpenAPI 3.0.02026-08-061280285.2 KB
Sequence APIs

Remove prospects from a sequence.

<br/>Removes one or more prospects from a sequence, stopping any further steps<br/>for them. Recipients are identified by their prospect_ids (the same ids you<br/>used to add them). As with adding recipients, user_id is required and must<br/>belong to your account.<br/><br/>Any requested prospect that is not enrolled in the sequence is a no-op.<br/>requested_count echoes the number of prospects submitted for removal.<br/>

post/api/external/sequences/recipients/remove

Headers

RF-Api-Keystring
content-typestring

Request body

prospect_idsinteger[] required

Ids of the candidates/contacts to remove.

sequence_idinteger required

Id of the sequence to remove recipients from.

user_idinteger required

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

Example request

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

Response

Recipients removed

{"stackTrail":"paths:/api/external/sequences/recipients/remove:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"RESULT":"SUCCESS","requested_count":1}}

Example response

{
  "RESULT": "SUCCESS",
  "requested_count": 1
}