Prospects

Update Status

PATCH/v1/prospects/status
PATCH
/v1/prospects/status

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

Authorization

x-api-key<token>

API key for Open API authentication

In: header

Request Body

application/jsonRequired

prospectAndSequenceIdsarray<object>

array of prospect id and step id

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

statusstring

status type to update

pauseDelayInDaysnumber

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

Responses

200
Prospect(s) status updated successfully
{
  "payload": {
    "success": 10,
    "failed": 1
  }
}

Request

curl -X PATCH \
  "https://open-api.saleshandy.com/v1/prospects/status" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "prospectAndSequenceIds": [
    {
      "prospectId": "2dP27N0gZ4",
      "sequenceId": "VMw56r9jPb"
    }
  ],
  "status": "string",
  "pauseDelayInDays": 0
}'

Response

No response body