ProspectsEdit a prospect

Edit a prospect

Needs: Prospects, Read-write

Edits contact details, stage, consultant, source, funding, lead and follow-up dates, initial notes and custom attributes. Send only what changes. To record a new event, add a note instead.

Errors

  • 422 with Provide something to change. when nothing is sent.
curl -X PATCH "https://app.imploy.com.au/api/integrations/v1/prospects/123" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "stage": "Contacted",
  "followup_date": "2026-03-05"
}'
{
  "updated": 21,
  "data": {
    "id": 21,
    "name": "Example Prospect",
    "first_name": "Example",
    "last_name": "Prospect",
    "email": "example.prospect@example.com",
    "phone": "0400 000 000",
    "suburb": "Perth",
    "date_of_lead": "2026-02-20",
    "stage": "New",
    "tags": [],
    "source": "Website",
    "consultant": "Example Consultant",
    "funding_type": "NDIS",
    "followup_date": "2026-03-05",
    "converted": false,
    "client_id": null
  }
}
PATCH
/prospects/{id}
PATCH
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
path
idinteger
Required

The prospect id.

Content-Typestring
Required

The media type of the request body

Options: application/json
stagestring

New, or a stage name from the options endpoint.

first_namestring

The first name. Required on create.

last_namestring

The last name. Required on create.

emailstring

Or null.

phonestring

Or null.

suburbstring

Or null.

date_of_leadstring

YYYY-MM-DD, or null.

followup_datestring

YYYY-MM-DD. null clears it.

sourcestring

Where the lead came from, or null.

consultantstring

The consultant's name, as on the Prospects page, or null.

funding_typestring

HCP, NDIS, CHSP or Private, or null.

notesstring

Initial comments, or null. Use the note endpoints to record events.

custom_attributesobject

Key and value pairs from the options endpoint. Lists for multiselect and checklist. null clears a value.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

Path Parameters

idinteger
Required

The prospect id.

Body

application/json
stagestring

New, or a stage name from the options endpoint.

first_namestring

The first name. Required on create.

last_namestring

The last name. Required on create.

emailstring

Or null.

phonestring

Or null.

suburbstring

Or null.

date_of_leadstring

YYYY-MM-DD, or null.

followup_datestring

YYYY-MM-DD. null clears it.

sourcestring

Where the lead came from, or null.

consultantstring

The consultant's name, as on the Prospects page, or null.

funding_typestring

HCP, NDIS, CHSP or Private, or null.

notesstring

Initial comments, or null. Use the note endpoints to record events.

custom_attributesobject

Key and value pairs from the options endpoint. Lists for multiselect and checklist. null clears a value.

Responses

OK