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


Get /leads

Provides the entire list of  leads

Returns the entire list of  leads. A lead is a contact with potential interest,a individual starts to be considered a Lead if the lead source is specified.

Request URL

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

Response Type

Response content type: JSON Array[  leads ]

ModelExample of Response
Array[leads]

Lead  {

comments(string): Specific text field for general information about this individual,

communication(Array[Communication]): The list of ways to communicate with this individual, including email, phone, LinkedIn, Facebook, Twitter and GooglePlus,

created(timestamp): individual creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

first_name(string): Individual first name,

id(string): unique identifier for this individual,

is_favorite(boolean): true or false if this individual is favorite for the current SalesSeek User (false by default),

locations(Array[Location]): List of addresses associated to this individual,

last_name(string): Individual last name,

modified(string): individual latest modification date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

organization_name(string): Organization Name this individual belongs to,

owner_id(string): ID for the SalesSeek User who owns this individual,

photo_url(string): entire url for an image assigned to this individual,

short_id(string): alias: shorter but still unique identifier for this individual,

source(Source): Lead source of this individual if defined,

source_id(string): Lead Source ID for this individual, if defined,

type(string): "individuals",

permissions(Array[string]): [

0: "salesseek.core.all_permissions"

1: "salesseek.core.edit"

2: "salesseek.core.view"

],

custom_fields(Associative Array): {

CustomFieldId1(String): CustomFieldValue1(String),

CustomFieldId2(String): CustomFieldValue2(String),

...

}

}

Source(JSON): {

id(string): Lead Source ID for this individual, if defined,

name(string): Text name of the lead source associated to tis individual, if defined,

}

Location  {

comments(string):Additional information related to the location, eg: working hours,

name(string): Text identifier for this location, eg: Home, Work, etc,

id (string): unique identifier for this location,

address(string): Complete Address

 }

Communication(JSON) {

id(string): unique identifier for the communication,

comments(string): text with the comments of this communication,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}


[
  0:{
    comments: "More information about this contact"
    communication: [{ 
      id:94c200, 
      value:alva@jacs.com, 
      comments: ""
      medium: "email"
      name: "Work"
    ]}
    created: "2014-01-16T13:31:12.335177"
    custom_fields: {
      9847a1c89: "Custom Field Value"
    }
    first_name: "Alva"
    id: "69d1fbe62"
    last_name: "Bart"
    modified: "2014-01-16T13:31:12.335177"
    organization_name: "Jacks"
    owner_id: "2901ecf25"
    permissions: [
      0: "salesseek.core.all_permissions"
      1: "salesseek.core.edit"
      2: "salesseek.core.view"
    ]
    photo_url: "https://pbs.twimg.com/profile/10/Twitpic1.jpg"
    short_id: "69d1fbe62"
    source: {
      id: "0d235a07dfe"
      name: "Web"
    }
    source_id: "007dfe"
    type: "individuals"
  },
  1:{....}
]


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
rowsInNThe maximum amount of element to be requestedint
startInNThe element number to start to retrieve the data (0 for the first position)int
order_byInNResults are ordered by the provided field name followed by &20desc or &20ascint




DELETE /leads

Deletes a specific list of lead by their ID

Deletes a specific list of lead by their IDs

Request URL

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

Request Body
[
  {"id": "88554461"},
  {"id": "88554462"},
  {"id": "88554463"}
]

Response Type

Response content type: null


Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
leads_idsInYThe list of leads ids to be deletedArray(id:String)





Get /leads/{lead _id} 

Provides the lead matching lead _id

Returns the unique lead matching the lead _Id

Request URL

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

Response Type

Response content type: JSON(Lead)

ModelExample of Response
Lead  {

comments(string): Specific text field for general information about this individual,

communication(Array[Communication]): The list of ways to communicate with this individual, including email, phone, LinkedIn, Facebook, Twitter and GooglePlus,

created(timestamp): individual creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

first_name(string): Individual first name,

id(string): unique identifier for this individual,

is_favorite(boolean): true or false if this individual is favorite for the current SalesSeek User (false by default),

locations(Array[Location]): List of addresses associated to this individual,

last_name(string): Individual last name,

modified(string): individual latest modification date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

organization_name(string): Organization Name this individual belongs to,

owner_id(string): ID for the SalesSeek User who owns this individual,

photo_url(string): entire url for an image assigned to this individual,

short_id(string): alias: shorter but still unique identifier for this individual,

source(Source): Lead source of this individual if defined,

source_id(string): Lead Source ID for this individual, if defined,

type(string): "individuals",

permissions(Array[string]): [

0: "salesseek.core.all_permissions"

1: "salesseek.core.edit"

2: "salesseek.core.view"

],

custom_fields(Associative Array): {

CustomFieldId1(String): CustomFieldValue1(String),

CustomFieldId2(String): CustomFieldValue2(String),

...

}

}

Source(JSON): {

id(string): Lead Source ID for this individual, if defined,

name(string): Text name of the lead source associated to tis individual, if defined,

}

Location  {

comments(string):Additional information related to the location, eg: working hours,

name(string): Text identifier for this location, eg: Home, Work, etc,

id (string): unique identifier for this location,

address(string): Complete Address

 }

Communication(JSON) {

id(string): unique identifier for the communication,

comments(string): text with the comments of this communication,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}


{
	id: "6b169999",
	is_favorite: false,
	first_name: "Nick",
	last_name: "Rome",
	comments: "He is mainly interested in developing new business in EMEA",
	created: "2014-01-15T19:36:56.597910",
	modified: "2014-01-15T19:36:56.597910",
	type: "individuals",
	custom_fields: {},
	locations: [
		0:{
			address: "20 Lake Road, London",
			name: "Work",
			organization_id: 8d6455af0c6
		}
 	]
	permissions: [
		0: "salesseek.core.all_permissions",
		1: "salesseek.core.edit",
		2: "salesseek.core.view",
	]
	organization_id: "8d6455af0c6",
	organization_name: "LiveImp",
	photo_url: "http://creativepool.com/marketing/images/minions-1.jpg",
	roles: [
		0: {
			title:CMO,
			organization_id:8d6455af0c6
		}
	}
	source: {
		cost: 0,
		cost_basis: "total",
		default_owner: null,
		id: "5a8a23be-e6d4-43d9-849b-2d800b1c8d47",
		name: "Twitter",
		owner_id: null,
		short_id: "5a8a23be-e6d4-43d9-849b-2d800b1c8d47",
		system_type: "twitter",
		type: "lead_sources"
	}
	communication: [
        0:{
            name:Work, 
            medium:phone, 
            value:+155448855, 
            comments:from 8:00 to 17:00
		}
		1: {
			name:Work,
			medium:email, 
			value:minion@gmail.com, 
			comments:From Mon to Sat
		}
		2: {
			medium:social, 
			name:linkedin, 
			value:https://www.linkedin.com/in/minrome/en
		}
		3: {
			medium:social, 
			name:twitter, 
			value:https://twitter.com/SalesSeek
		}
		4: {
			medium:social, 
			name:facebook, 
			value:https://www.facebook.com/SalesSeek?fref=ts
		}
		5: {
			medium:social, 
			name:googleplus, 
			value:https://plus.google.com/u/1/109741422344567872838/posts
		}
  }


Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 lead  _idInYThe id of  lead  to getstring
 lead Out-The  requested  lead  JSON




POST /lead

Create a new lead

Creates a new lead and Returns the resulting lead . The fields added are just the ones passed through the request body

Request URL

https://{client_id}.salesseek.net/api/lead/a3451f5--640585a5d026

Request Body
{
  first_name: "John",
  last_name: "Snow", #Mandatory
  source: {
      id: 8d6455af994545  #Mandatory
  }
  organization{ id: "8d6455af0c6"},
  locations: [
        0:{
            address: "20 Lake Road, London",
            name: "Work",
            organization_id: 8d6455af0c6
        }
    ]
}


Response Type

Response content type: JSON lead

ModelExample of Response

Lead  {

comments(string): Specific text field for general information about this individual,

communication(Array[Communication]): The list of ways to communicate with this individual, including email, phone, LinkedIn, Facebook, Twitter and GooglePlus,

created(timestamp): individual creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

first_name(string): Individual first name,

id(string): unique identifier for this individual,

is_favorite(boolean): true or false if this individual is favorite for the current SalesSeek User (false by default),

locations(Array[Location]): List of addresses associated to this individual,

last_name(string): Individual last name,

modified(string): individual latest modification date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

organization_name(string): Organization Name this individual belongs to,

owner_id(string): ID for the SalesSeek User who owns this individual,

photo_url(string): entire url for an image assigned to this individual,

short_id(string): alias: shorter but still unique identifier for this individual,

source(Source): Lead source of this individual if defined,

source_id(string): Lead Source ID for this individual, if defined,

type(string): "individuals",

permissions(Array[string]): [

0: "salesseek.core.all_permissions"

1: "salesseek.core.edit"

2: "salesseek.core.view"

],

custom_fields(Associative Array): {

CustomFieldId1(String): CustomFieldValue1(String),

CustomFieldId2(String): CustomFieldValue2(String),

...

}

}

Source(JSON): {

id(string): Lead Source ID for this individual, if defined,

name(string): Text name of the lead source associated to tis individual, if defined,

}

Location  {

comments(string):Additional information related to the location, eg: working hours,

name(string): Text identifier for this location, eg: Home, Work, etc,

id (string): unique identifier for this location,

address(string): Complete Address

 }

Communication(JSON) {

id(string): unique identifier for the communication,

comments(string): text with the comments of this communication,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}


{
	id: "6b169999",
	is_favorite: false,
	first_name: "Nick",
	last_name: "Rome",
	comments: "He is mainly interested in developing new business in EMEA",
	created: "2014-01-15T19:36:56.597910",
	modified: "2014-01-15T19:36:56.597910",
	type: "individuals",
	custom_fields: {},
	locations: [
		0:{
			address: "20 Lake Road, London",
			name: "Work",
			organization_id: 8d6455af0c6
		}
 	]
	permissions: [
		0: "salesseek.core.all_permissions",
		1: "salesseek.core.edit",
		2: "salesseek.core.view",
	]
	organization_id: "8d6455af0c6",
	organization_name: "LiveImp",
	photo_url: "http://creativepool.com/marketing/images/minions-1.jpg",
	roles: [
		0: {
			title:CMO,
			organization_id:8d6455af0c6
		}
	}
	source: {
		cost: 0,
		cost_basis: "total",
		default_owner: null,
		id: "5a8a23be-e6d4-43d9-849b-2d800b1c8d47",
		name: "Twitter",
		owner_id: null,
		short_id: "5a8a23be-e6d4-43d9-849b-2d800b1c8d47",
		system_type: "twitter",
		type: "lead_sources"
	}
	communication: [
        0:{
            name:Work, 
            medium:phone, 
            value:+155448855, 
            comments:from 8:00 to 17:00
		}
		1: {
			name:Work,
			medium:email, 
			value:minion@gmail.com, 
			comments:From Mon to Sat
		}
		2: {
			medium:social, 
			name:linkedin, 
			value:https://www.linkedin.com/in/minrome/en
		}
		3: {
			medium:social, 
			name:twitter, 
			value:https://twitter.com/SalesSeek
		}
		4: {
			medium:social, 
			name:facebook, 
			value:https://www.facebook.com/SalesSeek?fref=ts
		}
		5: {
			medium:social, 
			name:googleplus, 
			value:https://plus.google.com/u/1/109741422344567872838/posts
		}
  }

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type






 lead InYThe set of fields for the lead to be createdJSON
 lead OutThe  lead  after the successful creationJSON







PATCH /lead/{lead _id}

Update a specific  lead  by its ID

Updates a  lead  by { lead _id} and Returns the resulting  lead . The fields updated are just the ones passedon the request body

Request URL

https://{client_id}.salesseek.net/api/lead/a3451f5--640585a5d026

Request Body
{
  organization_id: "8d6455af0c6",
  organization_name: "LiveImp",
  locations: [
        0:{
            address: "20 Lake Road, London",
            name: "Work",
            organization_id: 8d6455af0c6
        }
    ]
}


Response Type

Response content type: JSON lead

ModelExample of Response

Lead  {

comments(string): Specific text field for general information about this individual,

communication(Array[Communication]): The list of ways to communicate with this individual, including email, phone, LinkedIn, Facebook, Twitter and GooglePlus,

created(timestamp): individual creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

first_name(string): Individual first name,

id(string): unique identifier for this individual,

is_favorite(boolean): true or false if this individual is favorite for the current SalesSeek User (false by default),

locations(Array[Location]): List of addresses associated to this individual,

last_name(string): Individual last name,

modified(string): individual latest modification date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

organization_name(string): Organization Name this individual belongs to,

owner_id(string): ID for the SalesSeek User who owns this individual,

photo_url(string): entire url for an image assigned to this individual,

short_id(string): alias: shorter but still unique identifier for this individual,

source(Source): Lead source of this individual if defined,

source_id(string): Lead Source ID for this individual, if defined,

type(string): "individuals",

permissions(Array[string]): [

0: "salesseek.core.all_permissions"

1: "salesseek.core.edit"

2: "salesseek.core.view"

],

custom_fields(Associative Array): {

CustomFieldId1(String): CustomFieldValue1(String),

CustomFieldId2(String): CustomFieldValue2(String),

...

}

}

Source(JSON): {

id(string): Lead Source ID for this individual, if defined,

name(string): Text name of the lead source associated to tis individual, if defined,

}

Location  {

comments(string):Additional information related to the location, eg: working hours,

name(string): Text identifier for this location, eg: Home, Work, etc,

id (string): unique identifier for this location,

address(string): Complete Address

 }

Communication(JSON) {

id(string): unique identifier for the communication,

comments(string): text with the comments of this communication,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}


{
	id: "6b169999",
	is_favorite: false,
	first_name: "Nick",
	last_name: "Rome",
	comments: "He is mainly interested in developing new business in EMEA",
	created: "2014-01-15T19:36:56.597910",
	modified: "2014-01-15T19:36:56.597910",
	type: "individuals",
	custom_fields: {},
	locations: [
		0:{
			address: "20 Lake Road, London",
			name: "Work",
			organization_id: 8d6455af0c6
		}
 	]
	permissions: [
		0: "salesseek.core.all_permissions",
		1: "salesseek.core.edit",
		2: "salesseek.core.view",
	]
	organization_id: "8d6455af0c6",
	organization_name: "LiveImp",
	photo_url: "http://creativepool.com/marketing/images/minions-1.jpg",
	roles: [
		0: {
			title:CMO,
			organization_id:8d6455af0c6
		}
	}
	source: {
		cost: 0,
		cost_basis: "total",
		default_owner: null,
		id: "5a8a23be-e6d4-43d9-849b-2d800b1c8d47",
		name: "Twitter",
		owner_id: null,
		short_id: "5a8a23be-e6d4-43d9-849b-2d800b1c8d47",
		system_type: "twitter",
		type: "lead_sources"
	}
	communication: [
        0:{
            name:Work, 
            medium:phone, 
            value:+155448855, 
            comments:from 8:00 to 17:00
		}
		1: {
			name:Work,
			medium:email, 
			value:minion@gmail.com, 
			comments:From Mon to Sat
		}
		2: {
			medium:social, 
			name:linkedin, 
			value:https://www.linkedin.com/in/minrome/en
		}
		3: {
			medium:social, 
			name:twitter, 
			value:https://twitter.com/SalesSeek
		}
		4: {
			medium:social, 
			name:facebook, 
			value:https://www.facebook.com/SalesSeek?fref=ts
		}
		5: {
			medium:social, 
			name:googleplus, 
			value:https://plus.google.com/u/1/109741422344567872838/posts
		}
  }

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 lead _idInYThe id of the  lead  to be updatedstring
 lead InYThe subset of fields from the lead to be updatedJSON
 lead OutThe  lead  after the successful updateJSON





DELETE /lead/{lead _id}

Deletes a specific lead by its ID

Delete a lead by {lead _id}

Request URL

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

Response Type

Response content type: null


Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 lead _idInYThe id of  lead  to be deletedstring




Get /leads/{lead_id}/activities

Provides the list of activities associated tothis lead 

Provides the list of activities associated tothis lead 

Request URL

https://{client_id}.salesseek.net/api/leads/69d1f4ae62/activities?start=0&rows=10&order_by=modified%20desc

Response Type

Response content type: JSON Array[Activities]

ModelExample of Response
Array[Activity]

Activity {

client_id (string): the unique reference to the SalesSeek Account

communication (JSON): {

(relationship with a communication way associated to an individual or organisation, could be an email, a phone number, etc)

client_id(string): the unique reference to the SalesSeek Account,

comments(string): text with the comments of this communication,

created (timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

creator_id(string): the id of the communication creator (User),

id(string): unique identifier for the communication,

last_modified_by_id(string): id of the User who modified this activity (if any),

latest(boolean): true or false if this is the latest communication associated to this individual,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

modified(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

type(string): communications,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}

created(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

 creator (JSON): {

email_address(string): unique email address identifying the user who created this activity),

id(string): unique identifier for the User who created the activity,

name(string): name of the user who created the activity,

}

creator_id: unique identifier for the User who created the activity,

id(string): unique identifier for this activity,

last_modified_by_id(string): unique identifier for the User who lately modified the activity,

latest(boolean): true or false if this is the latest activity for the current list,

modified(timestamp): modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

note(string): text describing this activity, anything the user introduces manually or automatically generated when emailed someone or called someone

owner_id(string): unique identifier for the User who owns the activity, is typically the creator, but can be modified,

photo_url(string): entire url for an image assigned to the User who lately modified the activity,

short_id(string): alias: shorter but still unique identifier for this activity,

target_date(timestamp): Due date for this activity (if set), formatted as YYYY-MM-ddThh_mm_ss.msecs,

target_type(string): an activity is always associated to a target (opportunities, individuals or organisations),

target_is_parent(boolean): true or false if the target has additional individuals associated to it,

type(string): "activities",

/*Depending on the target type of this activity then it should have one of the 3 following kind of fields*/

individual_deleted(boolean): true or false if the associated individual was deleted if the target was individuals,

individual_id(string): unique identifier of the associated individual if the target was individuals,

individual_name(string): name of the associated individual if the target was individuals,

individual_short_id(string): unique shorter identifier of the associated individual if the target was individuals,

opportunity_id(string): unique identifier of the associated individual if the target was opportunities,

opportunity_name(string): name of the associated individual if the target was opportunities,

opportunity_short_id(string): unique shorter identifier of the associated opportunity (deal) if the target was opportunities,

organization_id(string): unique identifier of the associated individual if the target was organizations,

organization_name(string): unique shorter identifier of the associated organization if the target was organizations,

organization_short_id(string): unique shorter identifier of the associated individual if the target was organizations,

}

[
  0:{
    client_id: "66990be5d6f",
    communication: {
        client_id: "669908c3-ce5d6f",
        comments: "",
        created: "2014-01-16T13:31:12.335177",
        creator_id: "2901efcbcf25",
        id: "945c06ec200",
        last_modified_by_id: "2901efbcf25",
        latest: true,
        medium: "email",
        modified: "2014-01-16T13:31:12.335177",
        name: "Work",
        type: "communications",
        value: "aleva@jacs.com",
         
    }
    created: "2014-01-18T16:21:31.680889",
    creator: {
        id:2901efb640cbcf25, 
        email_address:user1@gmail.com, 
        name:Kevin User 1
    }
    creator_id: "2901ef8bcf25",
    id: "c3418d621",
    individual_deleted: false,
    individual_id: "69d1f4ae62",
    individual_name: "Alex Van",
    individual_short_id: "69d1f3be62",
    last_modified_by_id: "2901efbcf25",
    latest: true,
    modified: "2014-01-18T16:21:31.680889",
    note: "emailed",
    opportunity_id: null,
    opportunity_name: null,
    opportunity_short_id: null,
    organization_id: null,
    organization_name: null,
    organization_short_id: null,
    owner_id: "2901ef0cbcf25",
    photo_url: "https://pbs.twimg.com/profile_images/10/Twitpic01.jpg",
    short_id: "c341806f621",
    target_date: null,
    target_is_parent: true,
    target_type: "individuals",
    type: "activities"
  }
,
  1:{....}
]


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
rowsInNThe maximum amount of element to be requestedint
startInNThe element number to start to retrieve the data (0 for the first position)int
order_byInNResults are ordered by the provided field name followed by &20desc or &20ascint




POST /leads/{lead_id}/activities

Creates a new Activity associated to lead {lead_id}

Creates a new Activity associated to lead {lead_id}

Request URL

https://{client_id}.salesseek.net/api/leads/888899/activities

Request Body
{
	communication:{
		comments: "From Mon to Sat",
		id: "2f103f9f-8e0e-41c1-aa2d-47a4a32a536a",
		medium: "email",
		name: "Work",
		value: "minion@gmail.com",
	}
	note: "emailed"
}


Response Type

Response content type: JSON Activity

ModelExample of Response

Activity {

client_id (string): the unique reference to the SalesSeek Account

communication (JSON): {

(relationship with a communication way associated to an individual or organisation, could be an email, a phone number, etc)

client_id(string): the unique reference to the SalesSeek Account,

comments(string): text with the comments of this communication,

created (timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

creator_id(string): the id of the communication creator (User),

id(string): unique identifier for the communication,

last_modified_by_id(string): id of the User who modified this activity (if any),

latest(boolean): true or false if this is the latest communication associated to this individual,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

modified(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

type(string): communications,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}

created(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

 creator (JSON): {

email_address(string): unique email address identifying the user who created this activity),

id(string): unique identifier for the User who created the activity,

name(string): name of the user who created the activity,

}

creator_id: unique identifier for the User who created the activity,

id(string): unique identifier for this activity,

last_modified_by_id(string): unique identifier for the User who lately modified the activity,

latest(boolean): true or false if this is the latest activity for the current list,

modified(timestamp): modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

note(string): text describing this activity, anything the user introduces manually or automatically generated when emailed someone or called someone

owner_id(string): unique identifier for the User who owns the activity, is typically the creator, but can be modified,

photo_url(string): entire url for an image assigned to the User who lately modified the activity,

short_id(string): alias: shorter but still unique identifier for this activity,

target_date(timestamp): Due date for this activity (if set), formatted as YYYY-MM-ddThh_mm_ss.msecs,

target_type(string): an activity is always associated to a target (opportunities, individuals or organisations),

target_is_parent(boolean): true or false if the target has additional individuals associated to it,

type(string): "activities",

/*Depending on the target type of this activity then it should have one of the 3 following kind of fields*/

individual_deleted(boolean): true or false if the associated individual was deleted if the target was individuals,

individual_id(string): unique identifier of the associated individual if the target was individuals,

individual_name(string): name of the associated individual if the target was individuals,

individual_short_id(string): unique shorter identifier of the associated individual if the target was individuals,

opportunity_id(string): unique identifier of the associated individual if the target was opportunities,

opportunity_name(string): name of the associated individual if the target was opportunities,

opportunity_short_id(string): unique shorter identifier of the associated opportunity (deal) if the target was opportunities,

organization_id(string): unique identifier of the associated individual if the target was organizations,

organization_name(string): unique shorter identifier of the associated organization if the target was organizations,

organization_short_id(string): unique shorter identifier of the associated individual if the target was organizations,

}

{
	client_id: "6699e5d6f"
	communication: {
		client_id: "6699e5d6f"
		comments: "From Mon to Sat"
		created: "2014-01-19T19:36:56.597910"
		creator_id: "2901ecbcf25"
		id: "2f1a536a"
		last_modified_by_id: "2901ecbcf25"
		latest: true
		medium: "email"
		modified: "2014-09-19T20:38:03.373365"
		name: "Work"
		owner_id: "2901ecbcf25"
		type: "communications"
		value: "minion@gmail.com"
	}
	created: "2014-01-19T20:48:03.810141"
	creator: {
		email_address: "ann@gmail.com"
		id: "2901ecbcf25"
		name: "Anna Karina"
	}
	creator_id: "2901ecbcf25"
	id: "9cbede5871"
	individual_deleted: false
	individual_id: "6b1664bbf95"
	individual_name: "Min Rome"
	individual_short_id: "6b1664bb5"
	last_modified_by_id: "2901ecbcf25"
	latest: true
	modified: "2014-01-19T20:48:03.810141"
	note: "emailed"
	opportunity_id: null
	opportunity_name: null
	opportunity_short_id: null
	organization_id: null
	organization_name: null
	organization_short_id: null
	owner_id: "2901ecbcf25"
	photo_url: "http://creativepool.com/marketing/images/minions-1.jpg"
	short_id: "9cbed4e5871"
	target_date: null
	target_is_parent: true
	target_type: "individuals"
	type: "activities"
  }

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
ActivityOut-The activity created after the successful requestJSON





DELETE /leads/{lead_id}/activities/{activity_id}

Deletes a specific Activity by its ID

Delete a specific Activity which is associated to the Lead {lead_id} by {activity_id}

Request URL

https://{client_id}.salesseek.net/api/leads/887766/activities/3-65a5d026

Response Type

Response content type: null


Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
activity_idInYThe id of activity to be deletedstring




PATCH /leads/{lead _id}/activities/{activity_id}

Update a specific Activity by its ID, associated to an {lead_id}

Updates an Activity by its ID and assocaited {lead _id} and Returns the resulting  Activity . The fields updated are just the ones passedon the request body

Request URL

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

Request Body
{
  note: "Waiting for her response about the price"
}


Response Type

Response content type: JSON Activity

ModelExample of Response

Activity {

client_id (string): the unique reference to the SalesSeek Account

communication (JSON): {

(relationship with a communication way associated to an individual or organisation, could be an email, a phone number, etc)

client_id(string): the unique reference to the SalesSeek Account,

comments(string): text with the comments of this communication,

created (timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

creator_id(string): the id of the communication creator (User),

id(string): unique identifier for the communication,

last_modified_by_id(string): id of the User who modified this activity (if any),

latest(boolean): true or false if this is the latest communication associated to this individual,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

modified(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

type(string): communications,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}

created(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

 creator (JSON): {

email_address(string): unique email address identifying the user who created this activity),

id(string): unique identifier for the User who created the activity,

name(string): name of the user who created the activity,

}

creator_id: unique identifier for the User who created the activity,

id(string): unique identifier for this activity,

last_modified_by_id(string): unique identifier for the User who lately modified the activity,

latest(boolean): true or false if this is the latest activity for the current list,

modified(timestamp): modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

note(string): text describing this activity, anything the user introduces manually or automatically generated when emailed someone or called someone

owner_id(string): unique identifier for the User who owns the activity, is typically the creator, but can be modified,

photo_url(string): entire url for an image assigned to the User who lately modified the activity,

short_id(string): alias: shorter but still unique identifier for this activity,

target_date(timestamp): Due date for this activity (if set), formatted as YYYY-MM-ddThh_mm_ss.msecs,

target_type(string): an activity is always associated to a target (opportunities, individuals or organisations),

target_is_parent(boolean): true or false if the target has additional individuals associated to it,

type(string): "activities",

/*Depending on the target type of this activity then it should have one of the 3 following kind of fields*/

individual_deleted(boolean): true or false if the associated individual was deleted if the target was individuals,

individual_id(string): unique identifier of the associated individual if the target was individuals,

individual_name(string): name of the associated individual if the target was individuals,

individual_short_id(string): unique shorter identifier of the associated individual if the target was individuals,

opportunity_id(string): unique identifier of the associated individual if the target was opportunities,

opportunity_name(string): name of the associated individual if the target was opportunities,

opportunity_short_id(string): unique shorter identifier of the associated opportunity (deal) if the target was opportunities,

organization_id(string): unique identifier of the associated individual if the target was organizations,

organization_name(string): unique shorter identifier of the associated organization if the target was organizations,

organization_short_id(string): unique shorter identifier of the associated individual if the target was organizations,

}

{
	client_id: "6699e5d6f"
	communication: {
		client_id: "6699e5d6f"
		comments: "From Mon to Sat"
		created: "2014-01-19T19:36:56.597910"
		creator_id: "2901ecbcf25"
		id: "2f1a536a"
		last_modified_by_id: "2901ecbcf25"
		latest: true
		medium: "email"
		modified: "2014-09-19T20:38:03.373365"
		name: "Work"
		owner_id: "2901ecbcf25"
		type: "communications"
		value: "minion@gmail.com"
	}
	created: "2014-01-19T20:48:03.810141"
	creator: {
		email_address: "ann@gmail.com"
		id: "2901ecbcf25"
		name: "Anna Karina"
	}
	creator_id: "2901ecbcf25"
	id: "9cbede5871"
	individual_deleted: false
	individual_id: "6b1664bbf95"
	individual_name: "Min Rome"
	individual_short_id: "6b1664bb5"
	last_modified_by_id: "2901ecbcf25"
	latest: true
	modified: "2014-01-19T20:48:03.810141"
	note: "emailed"
	opportunity_id: null
	opportunity_name: null
	opportunity_short_id: null
	organization_id: null
	organization_name: null
	organization_short_id: null
	owner_id: "2901ecbcf25"
	photo_url: "http://creativepool.com/marketing/images/minions-1.jpg"
	short_id: "9cbed4e5871"
	target_date: null
	target_is_parent: true
	target_type: "individuals"
	type: "activities"
  }

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
lead_idInYThe id of the  lead  which is associated this activitystring
activity_id InYThe id of the activity to be updatedJSON
Activity OutThe  Individual  after the successful updateJSON





Get /leads/{leads_id}/social

Provides the list of social interaction from to this lead 

Provides the list of social-network interactions with to this lead (his latest tweets if the Lead Source is Twitter or Facebook Posts)

Request URL

https://{client_id}.salesseek.net/api/leads/69d1f4ae62/activities?start=0&rows=10&order_by=modified%20desc

Response Type

Response content type: JSON Array[Social]

ModelExample of Response
Array[Social]

Social {

author_id(string): id of the individual who posted this social entry,

author_name(string): name of the individual who posted this social entry,

author_photo_url(string): entire url for an image assigned to the Individual who posted this social entry,

author_username(string): username (from the corresponding social network) who posted this social entry,

client_id(string): the unique reference to the SalesSeek Account,

created(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

creator_id: unique identifier for the User who created the activity,

id(string): unique identifier for the communication,

is_processed(boolean): true or false if this social entry has been processed,

item_id(string): unique identifier for the communication on the social network,

item_type(enum): tweet or post,

last_modified_by_id(string): id of the User who modified this activity (if haven't been modified = creator id),

latest(boolean): true or false if this is the latest social associated to this individual,

modified(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

network(enum): twitter or facebook,

owner_id(string): unique identifier for the User who owns the activity, is typically the creator, but can be modified,

short_id(string): alias or shorter, but still unique, identifier for this social entry,

text(string): Entire content of the social post,

type(string): "social_items",

owner(JSON): {

id(string): unique identifier for the SalesSeek User who owns the activity,

name(string): Name of the SalesSeek user who owns this social entry

}

author: {

created(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

first_name(string): first name of the individual who posted this social entry,

id(string): id of the individual who posted this social entry,

last_name(string): last name of the individual who posted this social entry,

photo_url(string): entire url for an image assigned to the Individual who posted this social entry,

short_id(string): shorter, but still unique, identifier for the author of this social entry,

}

[
  0:{
    author_id: "6a4fdfab",
    author_name: "Rob Johnson",
    author_photo_url: "https://pbs.twimg.com/profile_images/4sss.png",
    author_username: "robjohnson",
    client_id: "913fa92ea",
    created: "2014-01-19T11:59:04",
    creator_id: "9dab6268",
    id: "ba867e00c0",
    is_processed: false,
    item_id: "51680",
    item_type: "tweet",
    last_modified_by_id: "9db6268",
    latest: true,
    modified: "2014-01-19T12:01:38.991564",
    network: "twitter",
    owner_id: "94444da8",
    short_id: "94444d",
    text: "Sales Professional! http://t.co/oYAEDoc @mikebrook",
    type: "social_items",
    owner: {
      id: "94444da8",
      name: "Mike Brown"
    }
    author: {
      created: "2014-02-13T10:01:09.829480",
      first_name: "Rob",
      id: "6a4fdfab",
      last_name: "Johnson",
      photo_url: "data:image/jpeg;base64,/9QZ.jpg",
      short_id: "6a4b"
  }
  , 1:{...}
]


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
rowsInNThe maximum amount of element to be requestedint
startInNThe element number to start retrieving the data (0 for the first position)int
order_byInNResults are ordered by the provided field name followed by &20desc or &20ascint

Get /leads/{lead_id}/social/{social_id}

Provides the social entry matching {social_id} assigned to {lead_id}

Provides the social entry matching {social_id} assigned to {lead_id}. A social element represents a social-network interaction from to this lead (could be a tweet if the Lead Source is Twitter or a Facebook Post)

Request URL

https://{client_id}.salesseek.net/api/leads/69d1fbe62/social/88888

Response Type

Response content type: Social

ModelExample of Response

Social {

author_id(string): id of the individual who posted this social entry,

author_name(string): name of the individual who posted this social entry,

author_photo_url(string): entire url for an image assigned to the Individual who posted this social entry,

author_username(string): username (from the corresponding social network) who posted this social entry,

client_id(string): the unique reference to the SalesSeek Account,

created(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

creator_id: unique identifier for the User who created the activity,

id(string): unique identifier for the communication,

is_processed(boolean): true or false if this social entry has been processed,

item_id(string): unique identifier for the communication on the social network,

item_type(enum): tweet or post,

last_modified_by_id(string): id of the User who modified this activity (if haven't been modified = creator id),

latest(boolean): true or false if this is the latest social associated to this individual,

modified(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

network(enum): twitter or facebook,

owner_id(string): unique identifier for the User who owns the activity, is typically the creator, but can be modified,

short_id(string): alias or shorter, but still unique, identifier for this social entry,

text(string): Entire content of the social post,

type(string): "social_items",

owner(JSON): {

id(string): unique identifier for the SalesSeek User who owns the activity,

name(string): Name of the SalesSeek user who owns this social entry

}

author: {

created(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

first_name(string): first name of the individual who posted this social entry,

id(string): id of the individual who posted this social entry,

last_name(string): last name of the individual who posted this social entry,

photo_url(string): entire url for an image assigned to the Individual who posted this social entry,

short_id(string): shorter, but still unique, identifier for the author of this social entry,

}

{
    author_id: "6a4fdfab",
    author_name: "Rob Johnson",
    author_photo_url: "https://pbs.twimg.com/profile_images/4sss.png",
    author_username: "robjohnson",
    client_id: "913fa92ea",
    created: "2014-01-19T11:59:04",
    creator_id: "9dab6268",
    id: "ba867e00c0",
    is_processed: false,
    item_id: "51680",
    item_type: "tweet",
    last_modified_by_id: "9db6268",
    latest: true,
    modified: "2014-01-19T12:01:38.991564",
    network: "twitter",
    owner_id: "94444da8",
    short_id: "94444d",
    text: "Sales Professional! http://t.co/oYAEDoc @mikebrook",
    type: "social_items",
    owner: {
      id: "94444da8",
      name: "Mike Brown"
    }
    author: {
      created: "2014-02-13T10:01:09.829480",
      first_name: "Rob",
      id: "6a4fdfab",
      last_name: "Johnson",
      photo_url: "data:image/jpeg;base64,/9QZ.jpg",
      short_id: "6a4b"
  }

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Lead_idInYThe id of  Lead  who posted this social activitystring
Social_idInYThe id of  the social entry to getstring
SocialOut-The  Social entryJSON




PATCH /leads/{lead _id}/social/{social_id}

Update a specific Social by its ID, associated to an {lead_id}

Updates anSocial interaction by its ID and assocaited to {lead _id} and Returns the resulting  Activity . The fields updated are just the ones passedon the request body

Request URL

https://{client_id}.salesseek.net/api/leads/69d1fbe62/social/8877 

Request Body
{
  text: "William Jones: "Sales Professional!" http://t.co/oYAEDoc @mikebrook",
}


Response Type

Response content type: JSON Social

ModelExample of Response

Social {

author_id(string): id of the individual who posted this social entry,

author_name(string): name of the individual who posted this social entry,

author_photo_url(string): entire url for an image assigned to the Individual who posted this social entry,

author_username(string): username (from the corresponding social network) who posted this social entry,

client_id(string): the unique reference to the SalesSeek Account,

created(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

creator_id: unique identifier for the User who created the activity,

id(string): unique identifier for the communication,

is_processed(boolean): true or false if this social entry has been processed,

item_id(string): unique identifier for the communication on the social network,

item_type(enum): tweet or post,

last_modified_by_id(string): id of the User who modified this activity (if haven't been modified = creator id),

latest(boolean): true or false if this is the latest social associated to this individual,

modified(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

network(enum): twitter or facebook,

owner_id(string): unique identifier for the User who owns the activity, is typically the creator, but can be modified,

short_id(string): alias or shorter, but still unique, identifier for this social entry,

text(string): Entire content of the social post,

type(string): "social_items",

owner(JSON): {

id(string): unique identifier for the SalesSeek User who owns the activity,

name(string): Name of the SalesSeek user who owns this social entry

}

author: {

created(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

first_name(string): first name of the individual who posted this social entry,

id(string): id of the individual who posted this social entry,

last_name(string): last name of the individual who posted this social entry,

photo_url(string): entire url for an image assigned to the Individual who posted this social entry,

short_id(string): shorter, but still unique, identifier for the author of this social entry,

}

{
    author_id: "6a4fdfab",
    author_name: "Rob Johnson",
    author_photo_url: "https://pbs.twimg.com/profile_images/4sss.png",
    author_username: "robjohnson",
    client_id: "913fa92ea",
    created: "2014-01-19T11:59:04",
    creator_id: "9dab6268",
    id: "ba867e00c0",
    is_processed: false,
    item_id: "51680",
    item_type: "tweet",
    last_modified_by_id: "9db6268",
    latest: true,
    modified: "2014-09-19T12:01:38.991564",
    network: "twitter",
    owner_id: "94444da8",
    short_id: "94444d",
    text: "Sales Professional! http://t.co/oYAEDoc @mikebrook",
    type: "social_items",
    owner: {
      id: "94444da8",
      name: "Mike Brown"
    }
    author: {
      created: "2014-02-13T10:01:09.829480",
      first_name: "Rob",
      id: "6a4fdfab",
      last_name: "Johnson",
      photo_url: "data:image/jpeg;base64,/9QZ.jpg",
      short_id: "6a4b"
  }

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
lead_idInYThe id of the  lead  which is associated this activitystring
activity_id InYThe id of the activity to be updatedJSON
Activity InThe subset of the  Activity fields to be updatedJSON
Activity OutThe  Individual  after the successful updateJSON
  • No labels