---
title: "Update a Specific Prospect by ID"
method: PUT
path: "/v1/prospects/{prospect_id}"
tags: ["Prospects"]
---

# Update a Specific Prospect by ID

`PUT /v1/prospects/{prospect_id}`

Update a Specific Prospect by ID

## Path parameters

- `prospect_id` string, required — ID of the prospect

## Request body

- ProspectInput
  - `name` string, nullable — Name of the prospect
  - `email` string, email, nullable — Email of the prospect
  - `phoneNumber` string, nullable — Phone number of the prospect
  - `externalReference` ExternalReference[], nullable — External references for the prospect
    - `providerName` string, required — External service provider name
    - `id` string, required — External service identifier
    - `providerProps` object, nullable — Props for the external reference
  - `status` 'NEW' | 'GENERAL_ENQUIRY' | 'SCHEDULED_CALLBACK_WITH_BOT' | 'SCHEDULED_APPOINTMENT_WITH_PERSON' | 'SCHEDULED_APPOINTMENT_FOR_SERVICE' | 'NOT_INTERESTED' | 'PRODUCT_ORDER_PLACED' | 'SERVICE_ORDER_PLACED', required
  - `prospectProps` object, nullable — Props for the prospect

## Response `200`

Prospect updated successfully

- ProspectOutput — Prospects are the potential customers for business
  - `id` string, required
  - `orgId` string
  - `name` string, nullable
  - `email` string, nullable
  - `phoneNumber` string, nullable
  - `externalReference` ExternalReference[], nullable, required
    - `providerName` string, required — External service provider name
    - `id` string, required — External service identifier
    - `providerProps` object, nullable — Props for the external reference
  - `status` string, required
  - `prospectProps` object, nullable, required
  - `createdBy` string
  - `createdAt` string, date-time
  - `updatedBy` string
  - `updatedAt` string, date-time

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/tratahq/apis/trata-ai-api.md) · [All operations](https://skmtc.net/tratahq/apis/trata-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tratahq/trata-ai-api/versions/8f7b69ee5a90/schema)