prospects

Change status of prospects (Mark prospect as replied, finished, paused, unsubscribed and active)

patch/v1/prospects/status

Request body

statusstring required

status type to update

pauseDelayInDaysnumber

optional property to define pause delay in days in case of pausing prospects, only used when status=paused

Example request

{
  "prospectAndSequenceIds": [
    {
      "prospectId": "2dP27N0gZ4",
      "sequenceId": "VMw56r9jPb"
    }
  ]
}

Response

Prospect(s) status updated successfully<br><br>

{"stackTrail":"paths:/v1/prospects/status:patch:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"payload":{"success":10,"failed":1}}}

Example response

{
  "payload": {
    "success": 10,
    "failed": 1
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.