Lead Lists

Download schema

Create and organize lead lists

Retrieve Leads Lists

GET

https://api.tomba.io/v1

/leads_lists

Retrieve a list of leads lists.

Retrieve Leads Lists › Headers

X-Tomba-Key

string · required

API key used to authenticate requests. Send this value in the X-Tomba-Key header.

X-Tomba-Secret

string · required

API secret used with X-Tomba-Key to authenticate requests. Send this value in the X-Tomba-Secret header.

Retrieve Leads Lists › Responses

A list of leads lists.

LeadsList[]

Create Leads List

POST

https://api.tomba.io/v1

/leads_lists

Create a new leads list.

Create Leads List › Headers

X-Tomba-Key

string · required

API key used to authenticate requests. Send this value in the X-Tomba-Key header.

X-Tomba-Secret

string · required

API secret used with X-Tomba-Key to authenticate requests. Send this value in the X-Tomba-Secret header.

Create Leads List › Request Body

LeadsList

id

string · required

name

string · required

description

string

Lead[]

Create Leads List › Responses

Leads list created successfully.

LeadsList

id

string · required

name

string · required

description

string

Lead[]

POST/leads_lists

curl --request POST \
  --url https://api.tomba.io/v1/leads_lists \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '
{
  "id": "id",
  "name": "name",
  "description": "description",
  "leads": [
    {
      "id": "id",
      "email": "email",
      "firstName": "firstName",
      "lastName": "lastName",
      "company": "company",
      "title": "title",
      "attributes": [
        {
          "id": "id",
          "name": "name",
          "value": "value"
        }
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "id": "id",
  "name": "name",
  "description": "description",
  "leads": [
    {
      "id": "id",
      "email": "email",
      "firstName": "firstName",
      "lastName": "lastName",
      "company": "company",
      "title": "title",
      "attributes": [
        {
          "id": "id",
          "name": "name",
          "value": "value"
        }
      ]
    }
  ]
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "description",
  "leads": [
    {
      "id": "id",
      "email": "email",
      "firstName": "firstName",
      "lastName": "lastName",
      "company": "company",
      "title": "title",
      "attributes": [
        {
          "id": "id",
          "name": "name",
          "value": "value"
        }
      ]
    }
  ]
}

json

application/json

Retrieve a Single Leads List

GET

https://api.tomba.io/v1

/leads_lists/{listId}

Retrieve details of a specific leads list.

Retrieve a Single Leads List › path Parameters

listId

string · required

The ID of the leads list.

Retrieve a Single Leads List › Headers

X-Tomba-Key

string · required

API key used to authenticate requests. Send this value in the X-Tomba-Key header.

X-Tomba-Secret

string · required

API secret used with X-Tomba-Key to authenticate requests. Send this value in the X-Tomba-Secret header.

Retrieve a Single Leads List › Responses

A leads list object.

LeadsList

id

string · required

name

string · required

description

string

Lead[]

Update Leads List

PUT

https://api.tomba.io/v1

/leads_lists/{listId}

Update a specific leads list.

Update Leads List › path Parameters

listId

string · required

The ID of the leads list.

Update Leads List › Headers

X-Tomba-Key

string · required

API key used to authenticate requests. Send this value in the X-Tomba-Key header.

X-Tomba-Secret

string · required

API secret used with X-Tomba-Key to authenticate requests. Send this value in the X-Tomba-Secret header.

Update Leads List › Request Body

LeadsList

id

string · required

name

string · required

description

string

Lead[]

Update Leads List › Responses

Leads list updated successfully.

LeadsList

id

string · required

name

string · required

description

string

Lead[]

PUT/leads_lists/{listId}

curl --request PUT \
  --url https://api.tomba.io/v1/leads_lists/:listId \
  --header 'Content-Type: application/json' \
  --header 'X-Tomba-Key: ta_xxxx' \
  --header 'X-Tomba-Secret: ts_xxxx' \
  --data '
{
  "id": "id",
  "name": "name",
  "description": "description",
  "leads": [
    {
      "id": "id",
      "email": "email",
      "firstName": "firstName",
      "lastName": "lastName",
      "company": "company",
      "title": "title",
      "attributes": [
        {
          "id": "id",
          "name": "name",
          "value": "value"
        }
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "id": "id",
  "name": "name",
  "description": "description",
  "leads": [
    {
      "id": "id",
      "email": "email",
      "firstName": "firstName",
      "lastName": "lastName",
      "company": "company",
      "title": "title",
      "attributes": [
        {
          "id": "id",
          "name": "name",
          "value": "value"
        }
      ]
    }
  ]
}

json

Example Responses

No example specified for this content type

application/json

Delete Leads List

DELETE

https://api.tomba.io/v1

/leads_lists/{listId}

Delete a specific leads list.

Delete Leads List › path Parameters

listId

string · required

The ID of the leads list.

Delete Leads List › Headers

X-Tomba-Key

string · required

API key used to authenticate requests. Send this value in the X-Tomba-Key header.

X-Tomba-Secret

string · required

API secret used with X-Tomba-Key to authenticate requests. Send this value in the X-Tomba-Secret header.

Delete Leads List › Responses

Leads list deleted successfully.

No data returned

Lead Attributes Keys

Retrieve Leads Lists

GET

https://api.tomba.io/v1

/leads_lists

Retrieve a list of leads lists.

Retrieve Leads Lists › Headers

X-Tomba-Key

string · required

API key used to authenticate requests. Send this value in the X-Tomba-Key header.

X-Tomba-Secret

string · required

API secret used with X-Tomba-Key to authenticate requests. Send this value in the X-Tomba-Secret header.

Retrieve Leads Lists › Responses

A list of leads lists.

LeadsList[]

Create Leads List

POST

https://api.tomba.io/v1

/leads_lists

Create a new leads list.

Create Leads List › Headers

X-Tomba-Key

string · required

API key used to authenticate requests. Send this value in the X-Tomba-Key header.

X-Tomba-Secret

string · required

API secret used with X-Tomba-Key to authenticate requests. Send this value in the X-Tomba-Secret header.

Create Leads List › Request Body

LeadsList

id

string · required

name

string · required

description

string

Lead[]

Create Leads List › Responses

Leads list created successfully.

LeadsList

id

string · required

name

string · required

description

string

Lead[]

Retrieve a Single Leads List

GET

https://api.tomba.io/v1

/leads_lists/{listId}

Retrieve details of a specific leads list.

Retrieve a Single Leads List › path Parameters

listId

string · required

The ID of the leads list.

Retrieve a Single Leads List › Headers

X-Tomba-Key

string · required

API key used to authenticate requests. Send this value in the X-Tomba-Key header.

X-Tomba-Secret

string · required

API secret used with X-Tomba-Key to authenticate requests. Send this value in the X-Tomba-Secret header.

Retrieve a Single Leads List › Responses

A leads list object.

LeadsList

id

string · required

name

string · required

description

string

Lead[]

Update Leads List

PUT

https://api.tomba.io/v1

/leads_lists/{listId}

Update a specific leads list.

Update Leads List › path Parameters

listId

string · required

The ID of the leads list.

Update Leads List › Headers

X-Tomba-Key

string · required

API key used to authenticate requests. Send this value in the X-Tomba-Key header.

X-Tomba-Secret

string · required

API secret used with X-Tomba-Key to authenticate requests. Send this value in the X-Tomba-Secret header.

Update Leads List › Request Body

LeadsList

id

string · required

name

string · required

description

string

Lead[]

Update Leads List › Responses

Leads list updated successfully.

LeadsList

id

string · required

name

string · required

description

string

Lead[]

Delete Leads List

DELETE

https://api.tomba.io/v1

/leads_lists/{listId}

Delete a specific leads list.

Delete Leads List › path Parameters

listId

string · required

The ID of the leads list.

Delete Leads List › Headers

X-Tomba-Key

string · required

API key used to authenticate requests. Send this value in the X-Tomba-Key header.

X-Tomba-Secret

string · required

API secret used with X-Tomba-Key to authenticate requests. Send this value in the X-Tomba-Secret header.

Delete Leads List › Responses

Leads list deleted successfully.

No data returned