The Prospect object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

company_name string
industry string
market_segment string
customer_group string
territory string
no_of_employees string
annual_revenue number
fax string
website string
prospect_owner string
company string required
The Prospect object 
{
  "id": "prospect_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company_name": "Example Corp",
  "industry": "industry_example",
  "market_segment": "market_segment_example",
  "customer_group": "customer_group_example",
  "territory": "territory_example",
  "no_of_employees": "no_of_employees_example",
  "annual_revenue": 0,
  "fax": "fax_example",
  "website": "website_example",
  "prospect_owner": "prospect_owner_example",
  "company": "Example Corp"
}
GET /api/crm/prospect/{id}

Retrieve a prospect

Retrieves the details of an existing prospect. Supply the unique prospect ID that was returned from a previous request.

Path parameters

id string required

The identifier of the prospect to retrieve.

Returns

Returns the prospect object if a valid identifier was provided.

GET /api/crm/prospect/{id} 
curl https://api.overplane.dev/api/crm/prospect/prospect_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "prospect_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company_name": "Example Corp",
  "industry": "industry_example",
  "market_segment": "market_segment_example",
  "customer_group": "customer_group_example",
  "territory": "territory_example",
  "no_of_employees": "no_of_employees_example",
  "annual_revenue": 0,
  "fax": "fax_example",
  "website": "website_example",
  "prospect_owner": "prospect_owner_example",
  "company": "Example Corp"
}
GET /api/crm/prospect

List all prospects

Returns a list of prospects. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of prospect objects.

GET /api/crm/prospect 
curl https://api.overplane.dev/api/crm/prospect \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "prospect_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "company_name": "Example Corp",
      "industry": "industry_example",
      "market_segment": "market_segment_example",
      "customer_group": "customer_group_example",
      "territory": "territory_example",
      "no_of_employees": "no_of_employees_example",
      "annual_revenue": 0,
      "fax": "fax_example",
      "website": "website_example",
      "prospect_owner": "prospect_owner_example",
      "company": "Example Corp"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/crm/prospect

Create a prospect

Creates a new prospect object.

Body parameters

company_name string
industry string
market_segment string
customer_group string
territory string
no_of_employees string
annual_revenue number
fax string
website string
prospect_owner string
company string required

Returns

Returns the newly created prospect object if the call succeeded.

POST /api/crm/prospect 
curl https://api.overplane.dev/api/crm/prospect \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp"}'
Response 
{
  "id": "prospect_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company_name": "Example Corp",
  "industry": "industry_example",
  "market_segment": "market_segment_example",
  "customer_group": "customer_group_example",
  "territory": "territory_example",
  "no_of_employees": "no_of_employees_example",
  "annual_revenue": 0,
  "fax": "fax_example",
  "website": "website_example",
  "prospect_owner": "prospect_owner_example",
  "company": "Example Corp"
}
PATCH /api/crm/prospect/{id}

Update a prospect

Updates the specified prospect by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the prospect to update.

Body parameters

company_name string
industry string
market_segment string
customer_group string
territory string
no_of_employees string
annual_revenue number
fax string
website string
prospect_owner string
company string

Returns

Returns the updated prospect object.

PATCH /api/crm/prospect/{id} 
curl https://api.overplane.dev/api/crm/prospect/prospect_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"company_name":"Example Corp","industry":"industry_example"}'
Response 
{
  "id": "prospect_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company_name": "Example Corp",
  "industry": "industry_example",
  "market_segment": "market_segment_example",
  "customer_group": "customer_group_example",
  "territory": "territory_example",
  "no_of_employees": "no_of_employees_example",
  "annual_revenue": 0,
  "fax": "fax_example",
  "website": "website_example",
  "prospect_owner": "prospect_owner_example",
  "company": "Example Corp"
}
DELETE /api/crm/prospect/{id}

Delete a prospect

Permanently deletes a prospect. This cannot be undone.

Path parameters

id string required

The identifier of the prospect to delete.

Returns

Returns a confirmation that the prospect has been deleted.

DELETE /api/crm/prospect/{id} 
curl https://api.overplane.dev/api/crm/prospect/prospect_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "prospect_abc123",
  "deleted": true
}

Line items

Child objects that belong to this prospect. These are accessed via the parent's ID.

Prospect Lead

Attributes

idx integer
prospect_id string required
lead string required
lead_name string
status string
email string
mobile_no string
lead_owner string

Endpoints

GET /api/crm/prospect-lead?parent_id={id}
POST /api/crm/prospect-lead
PATCH /api/crm/prospect-lead/{id}
DELETE /api/crm/prospect-lead/{id}
POST /api/crm/prospect-lead/reorder
Prospect Lead object 
{
  "id": "prospect-lead_abc123",
  "idx": 1,
  "prospect_id": "prospect_id_example",
  "lead": "lead_example",
  "lead_name": "lead_name_example",
  "status": "draft",
  "email": "user@example.com",
  "mobile_no": "mobile_no_example",
  "lead_owner": "lead_owner_example"
}

Prospect Opportunity

Attributes

idx integer
prospect_id string required
opportunity string
amount number
stage string
probability number
expected_closing string
currency string
deal_owner string
contact_person string

Endpoints

GET /api/crm/prospect-opportunity?parent_id={id}
POST /api/crm/prospect-opportunity
PATCH /api/crm/prospect-opportunity/{id}
DELETE /api/crm/prospect-opportunity/{id}
POST /api/crm/prospect-opportunity/reorder
Prospect Opportunity object 
{
  "id": "prospect-opportunity_abc123",
  "idx": 1,
  "prospect_id": "prospect_id_example",
  "opportunity": "opportunity_example",
  "amount": 0,
  "stage": "stage_example",
  "probability": 0,
  "expected_closing": "expected_closing_example",
  "currency": "USD",
  "deal_owner": "deal_owner_example",
  "contact_person": "contact_person_example"
}