Convert a prospect
Needs: Prospects, Read-write, and Clients, Read-write
Converts a prospect to a new client, or links it to an existing client. It uses the profile conversion, enforces business access, and refuses a prospect that is already converted. Send either client_id, or client_type, business_id and language, never both.
Note:
datais what the profile conversion returns, so it is not repeated here.
curl -X POST "https://app.imploy.com.au/api/integrations/v1/prospects/123/convert" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"client_type": "NDIS",
"business_id": 1,
"language": "English"
}'
import requests
import json
url = "https://app.imploy.com.au/api/integrations/v1/prospects/123/convert"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"client_type": "NDIS",
"business_id": 1,
"language": "English"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://app.imploy.com.au/api/integrations/v1/prospects/123/convert", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"client_type": "NDIS",
"business_id": 1,
"language": "English"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"client_type": "NDIS",
"business_id": 1,
"language": "English"
}`)
req, err := http.NewRequest("POST", "https://app.imploy.com.au/api/integrations/v1/prospects/123/convert", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://app.imploy.com.au/api/integrations/v1/prospects/123/convert')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"client_type": "NDIS",
"business_id": 1,
"language": "English"
}'
response = http.request(request)
puts response.body
{
"converted": 21,
"data": {
"...": "..."
}
}
{
"message": "Invalid or expired access token."
}
{
"message": "Access token does not permit this action."
}
{
"message": "Too many requests."
}
/prospects/{id}/convertTarget server for requests. Edit to use your own host.
An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
imp_at_. Send it as Authorization: Bearer imp_at_XXXX.The prospect id.
The media type of the request body
Link an existing client instead of creating one.
HCP, SaH, THCP, GHCP, NDIS or Private. For a new client.
The business location. Required for a new client. See the client create options.
Required for a new client.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
Path Parameters
The prospect id.
Body
Link an existing client instead of creating one.
HCP, SaH, THCP, GHCP, NDIS or Private. For a new client.
The business location. Required for a new client. See the client create options.
Required for a new client.