Page tree
Skip to end of metadata
Go to start of metadata

Get /lead_sources

Provides the entire list of Lead Sources 

Returns the entire list of  Lead Sources.

As one of the most basic elements of SalesSeek CRM: A Lead is a contact who might be interested in the product and will be a focus of lead generation (consumer interest strategies). Leads can be created for purposes such as list building, e-newsletter list acquisition or for sales leads.

For its purpose a lead is a contact with a Lead Source for allowing to keep track of the marketing campaign it was obtained from or further follow up. Depending on how this contact reached the company database, its lead source may be some of the followings:

Automatic Lead Sources (coming from the corresponding configuration on SalesSeek Settings)

- Web Registration

-  Facebook

- Twitter

Manual lead sources

- LinkedIn

- Inbound

- *Any other new one added

Request URL

https://{client_id}.salesseek.net/api/lead_sources  

Response Type

Response content type: JSON Array[Lead_Sources]

ModelExample of Response

Array[Lead_Source]

 

Lead_Source {

cost (number): cost for getting this kind of leads, depends on the cost_basis,

cost_basis(Enum): Can be total: total cost of getting this entire group of leads, or cpl: cost per lead in case it is based on each new contact,

default_owner(User): the SalesSeek user this lead will be automatically assigned if defined, null otherwise,

id(string): unique identifier for this lead source,

short_id(string): alternative shorter unique identifier for this lead source,

system_type(string): if it is one of the automated from SalesSeek System this field may be one of the following: facebook, twitter, web, unspecified, inbound, null otherwise,

type(string): "lead_sources",

name (string): Lead Source name to be shown

}

User {

id (string): unique identifier for the User,

name (string): name to be shown,

}

[
    0:{
    	cost: 0,
		cost_basis: "total"
		default_owner: {
			id: "32102373412"
			name: "Michael Carter"
		}
		id: "729-47a"
		name: "Web Registration"
		owner_id: "32102373412"
		short_id: "729-47a"
		system_type: "web"
		type: "lead_sources"
    },
    1:{
		cost: 15,
		cost_basis: "cpl"
		default_owner: {
			id: "4910233173"
			name: "Cristina Black"
		}
		id: "c729-b787"
		name: "Web Registration"
		owner_id: "4910233173"
		short_id: "c729-b787"
		system_type: "Linked In"
		type: "lead_sources"
    },
	2:{...}
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Records-RowsOut-

Amount of records returned in this search

int
Records-StartOut-The index of the first row on the response (in case there are more results, paginated)int
Records-TotalOut-Total amount of records (even if are not in this search result)int
responseOut-Resulting list of Lead_sourcesArray[Lead_source]

 

 


 

 

POST /lead_sources

Creates a new Lead_source 

Creates a new Lead_source and Returns the resulting element 

Request URL

https://{client_id}.salesseek.net/api/lead_sources

Request Body
{
	name: "Mobile World Congress"
}

 

Response Type

Response content type: JSON Lead_Source

ModelExample of Response

Lead_Source {

cost (number): cost for getting this kind of leads, depends on the cost_basis,

cost_basis(Enum): Can be total: total cost of getting this entire group of leads, or cpl: cost per lead in case it is based on each new contact,

default_owner(User): the SalesSeek user this lead will be automatically assigned if defined, null otherwise,

id(string): unique identifier for this lead source,

short_id(string): alternative shorter unique identifier for this lead source,

system_type(string): if it is one of the automated from SalesSeek System this field may be one of the following: facebook, twitter, web, unspecified, inbound, null otherwise,

type(string): "lead_sources",

name (string): Lead Source name to be shown

}

User {

id (string): unique identifier for the User,

name (string): name to be shown,

}

{
	cost: 100,
    cost_basis: "total"
	default_owner: {
		id: "32102373412",
		name: "Michael Carter"
	}
	id: "2d34134",
	name: "Mobile World Congress",
	owner_id: 32102373412,
	short_id: "2d34134",
	system_type: null
	type: "lead_sources"
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
responseOut-The Lead Source created after the successful requestJSON

 

 


 

 

Get /lead_sources/{lead_source_id} 

Provides the Lead_source matching Lead_source_id

Returns the unique Lead_source matching the Lead_source_Id

As one of the most basic elements of SalesSeek CRM: An Lead_source is a contact on the system, it might be related to an Organization, may have assigned Deals, might be included in Groups depending on their rules, if defined Lead Source then is also a Lead.

Request URL

https://{client_id}.salesseek.net/api/lead_sources/69d1fbe62

Response Type

Response content type: Lead_Source

ModelExample of Response

Lead_Source {

cost (number): cost for getting this kind of leads, depends on the cost_basis,

cost_basis(Enum): Can be total: total cost of getting this entire group of leads, or cpl: cost per lead in case it is based on each new contact,

default_owner(User): the SalesSeek user this lead will be automatically assigned if defined, null otherwise,

id(string): unique identifier for this lead source,

short_id(string): alternative shorter unique identifier for this lead source,

system_type(string): if it is one of the automated from SalesSeek System this field may be one of the following: facebook, twitter, web, unspecified, inbound, null otherwise,

type(string): "lead_sources",

name (string): Lead Source name to be shown

}

User {

id (string): unique identifier for the User,

name (string): name to be shown,

}

{
	cost: 100,
    cost_basis: "total"
	default_owner: {
		id: "32102373412",
		name: "Michael Carter"
	}
	id: "2d34134",
	name: "Mobile World Congress",
	owner_id: 32102373412,
	short_id: "2d34134",
	system_type: null
	type: "lead_sources"
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 Lead_source_idInYThe id of Lead_source to be deletedstring
responseOut-The Lead_source created after the successful requestJSON

 

 


 

 

PATCH /lead_sources/{lead_source_id}

Update a specific Lead_source by its ID

Updates a Lead_source by its {lead_source_id} and Returns the resulting element. The fields updated are just the ones passed on the request body

 

Request URL

https://{client_id}.salesseek.net/api/lead_sources/69d1fbe62  

 

Request Body
{
	default_owner: {
	    id: "5f548601-c441-4992-bb8f-a0c7f62048c9"
	}
}

 

Response Type

Response content type: JSON Lead_Source

ModelExample of Response

Lead_Source {

cost (number): cost for getting this kind of leads, depends on the cost_basis,

cost_basis(Enum): Can be total: total cost of getting this entire group of leads, or cpl: cost per lead in case it is based on each new contact,

default_owner(User): the SalesSeek user this lead will be automatically assigned if defined, null otherwise,

id(string): unique identifier for this lead source,

short_id(string): alternative shorter unique identifier for this lead source,

system_type(string): if it is one of the automated from SalesSeek System this field may be one of the following: facebook, twitter, web, unspecified, inbound, null otherwise,

type(string): "lead_sources",

name (string): Lead Source name to be shown

}

User {

id (string): unique identifier for the User,

name (string): name to be shown,

}

{
	cost: 100,
    cost_basis: "total"
	default_owner: {
		id: "32102373412",
		name: "Michael Carter"
	}
	id: "2d34134",
	name: "Mobile World Congress",
	owner_id: 32102373412,
	short_id: "2d34134",
	system_type: null
	type: "lead_sources"
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Lead_source_idInYThe id of the Lead_source to be updatedstring
 Lead_source InYThe subset of the Lead_source fields to be updatedJSON
 response OutThe Lead_source after the successful updateJSON

 

 


 

 

DELETE /lead_sources/{lead_source_id}

Deletes a specific Lead_source by its ID

Deletes a Lead_source by it {lead_source_id}

Request URL

https://{client_id}.salesseek.net/api/lead_sources/a3451f5  

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 Lead_source_idInYThe id of Lead_source to be deletedstring
  • No labels