The Lead 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.

lead_name string

company_name string

email_id string

lead_owner string

Default: __user

status string

Default: Lead

salutation string

gender string

customer string

image string

phone string

mobile_no string

fax string

type string

market_segment string

industry string

request_type string

company string

website string

territory string

unsubscribed boolean

Default: false

blog_subscriber boolean

Default: false

title string

language string

first_name string

middle_name string

last_name string

no_of_employees string

whatsapp_no string

phone_ext string

qualified_by string

qualified_on string

qualification_status string

job_title string

annual_revenue number

disabled boolean

Default: false

city string

state string

country string

utm_content string

utm_source string

utm_medium string

utm_campaign string

The Lead object

{
  "id": "lead_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "lead_name": "lead_name_example",
  "company_name": "Example Corp",
  "email_id": "[email protected]",
  "lead_owner": "__user",
  "status": "Lead",
  "salutation": "salutation_example",
  "gender": "gender_example",
  "customer": "customer_example",
  "image": "image_example",
  "phone": "phone_example",
  "mobile_no": "mobile_no_example",
  "fax": "fax_example",
  "type": "type_example",
  "market_segment": "market_segment_example",
  "industry": "industry_example",
  "request_type": "request_type_example",
  "company": "Example Corp",
  "website": "website_example",
  "territory": "territory_example",
  "unsubscribed": false,
  "blog_subscriber": false,
  "title": "title_example",
  "language": "language_example",
  "first_name": "first_name_example",
  "middle_name": "middle_name_example",
  "last_name": "last_name_example",
  "no_of_employees": "no_of_employees_example",
  "whatsapp_no": "whatsapp_no_example",
  "phone_ext": "phone_ext_example",
  "qualified_by": "qualified_by_example",
  "qualified_on": "qualified_on_example",
  "qualification_status": "qualification_status_example",
  "job_title": "job_title_example",
  "annual_revenue": 0,
  "disabled": false,
  "city": "city_example",
  "state": "state_example",
  "country": "country_example",
  "utm_content": "utm_content_example",
  "utm_source": "utm_source_example",
  "utm_medium": "utm_medium_example",
  "utm_campaign": "utm_campaign_example"
}

GET /api/crm/lead/{id}

Retrieve a lead

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

Path parameters

id string required

The identifier of the lead to retrieve.

Returns

Returns the lead object if a valid identifier was provided.

GET /api/crm/lead/{id}

curl https://api.overplane.dev/api/crm/lead/lead_abc123 \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "lead_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "lead_name": "lead_name_example",
  "company_name": "Example Corp",
  "email_id": "[email protected]",
  "lead_owner": "__user",
  "status": "Lead",
  "salutation": "salutation_example",
  "gender": "gender_example",
  "customer": "customer_example",
  "image": "image_example",
  "phone": "phone_example",
  "mobile_no": "mobile_no_example",
  "fax": "fax_example",
  "type": "type_example",
  "market_segment": "market_segment_example",
  "industry": "industry_example",
  "request_type": "request_type_example",
  "company": "Example Corp",
  "website": "website_example",
  "territory": "territory_example",
  "unsubscribed": false,
  "blog_subscriber": false,
  "title": "title_example",
  "language": "language_example",
  "first_name": "first_name_example",
  "middle_name": "middle_name_example",
  "last_name": "last_name_example",
  "no_of_employees": "no_of_employees_example",
  "whatsapp_no": "whatsapp_no_example",
  "phone_ext": "phone_ext_example",
  "qualified_by": "qualified_by_example",
  "qualified_on": "qualified_on_example",
  "qualification_status": "qualification_status_example",
  "job_title": "job_title_example",
  "annual_revenue": 0,
  "disabled": false,
  "city": "city_example",
  "state": "state_example",
  "country": "country_example",
  "utm_content": "utm_content_example",
  "utm_source": "utm_source_example",
  "utm_medium": "utm_medium_example",
  "utm_campaign": "utm_campaign_example"
}

GET /api/crm/lead

List all leads

Returns a list of leads. 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 lead objects.

GET /api/crm/lead

curl https://api.overplane.dev/api/crm/lead \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "data": [
    {
      "id": "lead_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "lead_name": "lead_name_example",
      "company_name": "Example Corp",
      "email_id": "[email protected]",
      "lead_owner": "__user",
      "status": "Lead",
      "salutation": "salutation_example",
      "gender": "gender_example",
      "customer": "customer_example",
      "image": "image_example",
      "phone": "phone_example",
      "mobile_no": "mobile_no_example",
      "fax": "fax_example",
      "type": "type_example",
      "market_segment": "market_segment_example",
      "industry": "industry_example",
      "request_type": "request_type_example",
      "company": "Example Corp",
      "website": "website_example",
      "territory": "territory_example",
      "unsubscribed": false,
      "blog_subscriber": false,
      "title": "title_example",
      "language": "language_example",
      "first_name": "first_name_example",
      "middle_name": "middle_name_example",
      "last_name": "last_name_example",
      "no_of_employees": "no_of_employees_example",
      "whatsapp_no": "whatsapp_no_example",
      "phone_ext": "phone_ext_example",
      "qualified_by": "qualified_by_example",
      "qualified_on": "qualified_on_example",
      "qualification_status": "qualification_status_example",
      "job_title": "job_title_example",
      "annual_revenue": 0,
      "disabled": false,
      "city": "city_example",
      "state": "state_example",
      "country": "country_example",
      "utm_content": "utm_content_example",
      "utm_source": "utm_source_example",
      "utm_medium": "utm_medium_example",
      "utm_campaign": "utm_campaign_example"
    }
  ],
  "has_more": false,
  "total": 1
}

POST /api/crm/lead

Create a lead

Creates a new lead object.

Body parameters

lead_name string

company_name string

email_id string

lead_owner string

Default: __user

status string

Default: Lead

salutation string

gender string

customer string

image string

phone string

mobile_no string

fax string

type string

market_segment string

industry string

request_type string

company string

website string

territory string

unsubscribed boolean

Default: false

blog_subscriber boolean

Default: false

title string

language string

first_name string

middle_name string

last_name string

no_of_employees string

whatsapp_no string

phone_ext string

qualified_by string

qualified_on string

qualification_status string

job_title string

annual_revenue number

disabled boolean

Default: false

city string

state string

country string

utm_content string

utm_source string

utm_medium string

utm_campaign string

Returns

Returns the newly created lead object if the call succeeded.

POST /api/crm/lead

curl https://api.overplane.dev/api/crm/lead \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"

Response

{
  "id": "lead_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "lead_name": "lead_name_example",
  "company_name": "Example Corp",
  "email_id": "[email protected]",
  "lead_owner": "__user",
  "status": "Lead",
  "salutation": "salutation_example",
  "gender": "gender_example",
  "customer": "customer_example",
  "image": "image_example",
  "phone": "phone_example",
  "mobile_no": "mobile_no_example",
  "fax": "fax_example",
  "type": "type_example",
  "market_segment": "market_segment_example",
  "industry": "industry_example",
  "request_type": "request_type_example",
  "company": "Example Corp",
  "website": "website_example",
  "territory": "territory_example",
  "unsubscribed": false,
  "blog_subscriber": false,
  "title": "title_example",
  "language": "language_example",
  "first_name": "first_name_example",
  "middle_name": "middle_name_example",
  "last_name": "last_name_example",
  "no_of_employees": "no_of_employees_example",
  "whatsapp_no": "whatsapp_no_example",
  "phone_ext": "phone_ext_example",
  "qualified_by": "qualified_by_example",
  "qualified_on": "qualified_on_example",
  "qualification_status": "qualification_status_example",
  "job_title": "job_title_example",
  "annual_revenue": 0,
  "disabled": false,
  "city": "city_example",
  "state": "state_example",
  "country": "country_example",
  "utm_content": "utm_content_example",
  "utm_source": "utm_source_example",
  "utm_medium": "utm_medium_example",
  "utm_campaign": "utm_campaign_example"
}

PATCH /api/crm/lead/{id}

Update a lead

Updates the specified lead 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 lead to update.

Body parameters

lead_name string

company_name string

email_id string

lead_owner string

Default: __user

status string

Default: Lead

salutation string

gender string

customer string

image string

phone string

mobile_no string

fax string

type string

market_segment string

industry string

request_type string

company string

website string

territory string

unsubscribed boolean

Default: false

blog_subscriber boolean

Default: false

title string

language string

first_name string

middle_name string

last_name string

no_of_employees string

whatsapp_no string

phone_ext string

qualified_by string

qualified_on string

qualification_status string

job_title string

annual_revenue number

disabled boolean

Default: false

city string

state string

country string

utm_content string

utm_source string

utm_medium string

utm_campaign string

Returns

Returns the updated lead object.

PATCH /api/crm/lead/{id}

curl https://api.overplane.dev/api/crm/lead/lead_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"lead_name":"lead_name_example","company_name":"Example Corp"}'

Response

{
  "id": "lead_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "lead_name": "lead_name_example",
  "company_name": "Example Corp",
  "email_id": "[email protected]",
  "lead_owner": "__user",
  "status": "Lead",
  "salutation": "salutation_example",
  "gender": "gender_example",
  "customer": "customer_example",
  "image": "image_example",
  "phone": "phone_example",
  "mobile_no": "mobile_no_example",
  "fax": "fax_example",
  "type": "type_example",
  "market_segment": "market_segment_example",
  "industry": "industry_example",
  "request_type": "request_type_example",
  "company": "Example Corp",
  "website": "website_example",
  "territory": "territory_example",
  "unsubscribed": false,
  "blog_subscriber": false,
  "title": "title_example",
  "language": "language_example",
  "first_name": "first_name_example",
  "middle_name": "middle_name_example",
  "last_name": "last_name_example",
  "no_of_employees": "no_of_employees_example",
  "whatsapp_no": "whatsapp_no_example",
  "phone_ext": "phone_ext_example",
  "qualified_by": "qualified_by_example",
  "qualified_on": "qualified_on_example",
  "qualification_status": "qualification_status_example",
  "job_title": "job_title_example",
  "annual_revenue": 0,
  "disabled": false,
  "city": "city_example",
  "state": "state_example",
  "country": "country_example",
  "utm_content": "utm_content_example",
  "utm_source": "utm_source_example",
  "utm_medium": "utm_medium_example",
  "utm_campaign": "utm_campaign_example"
}

DELETE /api/crm/lead/{id}

Delete a lead

Permanently deletes a lead. This cannot be undone.

Path parameters

id string required

The identifier of the lead to delete.

Returns

Returns a confirmation that the lead has been deleted.

DELETE /api/crm/lead/{id}

curl https://api.overplane.dev/api/crm/lead/lead_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE

Response

{
  "id": "lead_abc123",
  "deleted": true
}

The Lead object

Attributes

Retrieve a lead

Path parameters

Returns

List all leads

Query parameters

Returns

Create a lead

Body parameters

Returns

Update a lead

Path parameters

Body parameters

Returns

Delete a lead

Path parameters

Returns

Coming Soon