Classifies multiple prospects in one project to the same pipeline stage.

Path Parameters

projectId
Type: string
required

Project ID

Body·

required

Batch classification request

Request body for batch-classifying prospects in a project.

classification
Type: string Pattern: ^(not_contacted|contacted|interested|not_interested|bidder)$
required

Pipeline stage to set: not_contacted, contacted, interested, not_interested, bidder.
prospectIds
Type: array string[] …100
required

List of prospect IDs to classify. Maximum 100.
note
Type: null | string

Optional note attached to each prospect's classification, shown in the prospect note column. Omit (or send null) for no note; whitespace-only is rejected.

Responses

application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json

post/api/v1/projects/{projectId}/prospects/classify

curl 'https://app.propstreet.com/api/v1/projects/{projectId}/prospects/classify' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "prospectIds": [
    ""
  ],
  "classification": "",
  "note": null
}'

Show Schema

{
  "classified": 1,
  "succeeded": [
    "string"
  ],
  "failed": [
    {
      "prospectId": "string",
      "error": "string"
    }
  ]
}