Create or change a view

Needs: Prospects, Read-write

Creates a saved prospect view shared across the organisation. Send an id in the body to change an existing view instead; only the parts you send change. A name that is already in use is refused.

Note: When you change a view with its id, the response has updated in place of created.

curl -X POST "https://app.imploy.com.au/api/integrations/v1/prospect-views" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "name": "Hot leads",
  "mode": "kanban",
  "group_by": "stage",
  "filters": [
    {
      "field": "prospect_funding_type",
      "operator": "is",
      "value": "NDIS"
    }
  ]
}'

import requests
import json

url = "https://app.imploy.com.au/api/integrations/v1/prospect-views"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
  "name": "Hot leads",
  "mode": "kanban",
  "group_by": "stage",
  "filters": [
    {
      "field": "prospect_funding_type",
      "operator": "is",
      "value": "NDIS"
    }
  ]
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://app.imploy.com.au/api/integrations/v1/prospect-views", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
},
  body: JSON.stringify({
  "name": "Hot leads",
  "mode": "kanban",
  "group_by": "stage",
  "filters": [
    {
      "field": "prospect_funding_type",
      "operator": "is",
      "value": "NDIS"
    }
  ]
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "name": "Hot leads",
  "mode": "kanban",
  "group_by": "stage",
  "filters": [
    {
      "field": "prospect_funding_type",
      "operator": "is",
      "value": "NDIS"
    }
  ]
}`)

    req, err := http.NewRequest("POST", "https://app.imploy.com.au/api/integrations/v1/prospect-views", 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/prospect-views')
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 = '{
  "name": "Hot leads",
  "mode": "kanban",
  "group_by": "stage",
  "filters": [
    {
      "field": "prospect_funding_type",
      "operator": "is",
      "value": "NDIS"
    }
  ]
}'

response = http.request(request)
puts response.body

{
  "created": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "name": "Hot leads"
}

POST

/prospect-views

POST

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.

Content-Typestring

Required

The media type of the request body

Options: application/json

idstring

An existing view id. Leave out to create a view.

namestring

The view name (up to 80 characters).

iconstring

One emoji. Empty for the default icon.

modestring

all (table) or kanban.

group_bystring

Kanban columns: stage, consultant, fundingType or source.

filtersarray

Replaces the filters. Each needs field and operator, plus value and an optional combinator (and or or). Fields: prospect_name, prospect_email, prospect_phone, prospect_suburb, prospect_stage, prospect_source, prospect_consultant, prospect_funding_type, prospect_date_of_lead, or custom:prospect: plus an attribute key. Operators: contains, does_not_contain, starts_with, ends_with, is, is_not, empty or not_empty.