prospects

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

patch/v1/prospects/status

Request

Base URL
https://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/saleshandy/apis/develop-with-saleshandy/docs/v1/prospects/status/patch.ts
A function with typed inputs. Its response is checked against the schema.

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

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

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

unknown required

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

No recorded changes to this operation across all 4 revisions of this API.