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

 

Get /opportunities

Provides the entire list of  opportunities

Returns the entire list of  opportunities . A opportunity can have 1 or more revenue buckets depending on the business model. Each revenue bucket has its own behaviour in terms of average selling price, length, renewal probability, recognition policy (percentage paid at the start, monthly and end). A bucket can be a product line, a service, a license, etc.

All associated configuration is intended for the Revenue Planer capacity for the future.

Request URL

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

Response Type

Response content type: JSON Array[  opportunities  ]

ModelExample of Response
Array[opportunities]


Opportunity (JSON) {

currency(Enum): 3 letters abbreviation for the currency affecting all revenue buckets of this deal,

expected_close_date(timestamp): estimated close date for this deal, formatted as YYYY-MM-ddThh_mm_ss.msecs,

id (string): unique identifier for this opportunity,

name(string): Deal's name to be shown,

phase(Phase): details about the specific Funnel Phase this deal is,

buckets(Array[Buckets]): List of revenue bucket for this current deal,

custom_fields (Associative Array): Associative array organised in pairs of id: value,

default_value(number): ?????,

latest_activity_in_days(int): Amount of days since the last activity over this deal,

organization(Organization): A deal is always related to an organization (required),

organization_id: unique identifier for the organization the deal is associated,

owner(Owner): each deal has a SalesSeek user who owns it (is responsible of),

owner_id(string): unique identifier for the SalesSeek user who owns this deal,

permissions: [???],

phase_id(string): id of the Funnel Phase this deal is,

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

phase_name(string): name of the Funnel Phase this deal is,

phase_number(int): position number of the Funnel Phase this deal is,

short_id(string): Alias which can be used as a unique identifier for the Bucket,

type(string): "opportunities",

value(number): total deal's size: sum of all bucket values,

comments(string): additional generic information not included on other fields (or custom fields),

is_favorite(boolean): true or false if this deal is favorite for the current SalesSeek user

}

 

Buckets(JSON): {

id (string): unique identifier for this bucket,

name (int): bucket name to be shown,

value (number): value for the current bucket inside this deal (depends on the currency),

default_value (string): ???

}

Organization(JSON): {

id (string): unique identifier for this organization,

name (int): organization name to be shown

}

Owner(JSON): {

id (string): unique identifier for the SalesSeek user who owns this deal,

name (int): name of the SalesSeek user who owns this deal

}

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

}

 

[
  {
    abbreviation: "F25"
    buckets: [
      0:{
        name:New Structure, 
        value:75000, 
        default_value:75000, 
        id:7d2e38b6d
      },
      1:{…}
    ]
    currency: "USD"
    custom_fields: {
      128d597afb923a:"https://www.google.com/NewStructure"
    }
    default_value: 75000
    expected_close_date: "2014-01-29T23:00:00"
    id: "184ffbf0aad9"
    latest_activity_in_days: 3
    name: "Refurbishing Opera House"
    organization: {
      id: "8d6455f0c6"
      name: "Opera House"
    }
    organization_id: "8d6455f0c6"
    owner: {
      id: "2901f25"
      name: "Anna Karina"
    }
    owner_id: "2901f25"
    permissions: [
      0: "salesseek.core.view",
      1: "salesseek.core.all_permissions",
      2: "salesseek.core.edit"
    ]
    phase: {
      id: "5b540b026a8"
      name: "Scheduled Visit"
      order: 2
    }
    phase_id: "5b540b026a8"
    phase_last_changed: "2014-01-18T12:26:30.055763"
    phase_name: "Scheduled visit"
    phase_number: 2
    short_id: "5b540b028"
    type: "opportunities"
    value: 75000
  },
  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 requested (-1 for not limiting)int
startInNThe element number to start to retrieve the data (0 for the first position)int
owner_idInNSalesSeek User id in case filtering by owner is neededint

 


 

Get /opportunities?search=name_string

Provides the the subset of opportunities which name matches the name_string

Provides the the subset of opportunities which name matches the name_substring. As it is intended to be used in searches then the set of information from the opportunity is limited.

Request URL

https://{client_id}.salesseek.net/api/opportunities?search=town

Response Type

Response content type: JSON Array[  opportunities  ]

ModelExample of Response

Array[opportunities]

opportunity  {

id (string): unique identifier for this deal,

permissions: [???],

short_id(string): Alias which can be used as a unique identifier for the Bucket,

thumbnail(string): entire url for an image representing this deal,

titile(string): deal name to be shown as search result,

title_highlight(string): deal name to be shown as search result including HTML tag <em> surrounding the substring matching the search filter

type(string): "salesseek.opportunities.models.opportunity.Opportunity"

}

[
  {
    id: "184ffbf0aad9",
    permissions: [
      0: "salesseek.core.view",
      1: "salesseek.core.all_permissions",
      2: "salesseek.core.edit"
    ]
    short_id: "5b540b028",
    thumbnail:"http://images.com/thum1.jpg",
    title: "Refurbishing Town House",
    title_highlight:"<em>Town</em> Hall Structure Design",
    type: "salesseek.opportunities.models.opportunity.Opportunity"
  },
  1:{...
  }
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
searchInYString used for searching all deals which names contain the value of this parameterstring

 


 

POST opportunity 

Creates a new opportunity 

Creates a new opportunity (or deal)  and returns the resulting opportunity 

 

Request URL

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

Request Body
{
    abbreviation: "THS"
    buckets: [
        0:{
             id:8bc7b81, 
             name:Project Design, 
             value:20000
         },
         1:{
             id:8bc7b82, 
             name:Urbanization Plan, 
             value:3000}
    ]
    comments: "only 2 more companies had answered their RFQ"
    currency: "USD"
    expected_close_date: "2014-11-16T00:00:00.000Z"
    files: [
        0: "edf66139dc71f"
    ]
    name: "Town Hall Structure Design"
    organization: {
        name:Town Hall,
        roles:[],
        locations:[],
        communication:[]
    }
    communication: []
    locations: []
    name: "Town Hall"
    roles: []
    phase_id: "4487844e"
    value: 0
  }

 

Response Type

Response content type: JSON opportunity

ModelExample of Response


Opportunity (JSON) {

currency(Enum): 3 letters abbreviation for the currency affecting all revenue buckets of this deal,

expected_close_date(timestamp): estimated close date for this deal, formatted as YYYY-MM-ddThh_mm_ss.msecs,

id (string): unique identifier for this opportunity,

name(string): Deal's name to be shown,

phase(Phase): details about the specific Funnel Phase this deal is,

buckets(Array[Buckets]): List of revenue bucket for this current deal,

custom_fields (Associative Array): Associative array organised in pairs of id: value,

default_value(number): ?????,

latest_activity_in_days(int): Amount of days since the last activity over this deal,

organization(Organization): A deal is always related to an organization (required),

organization_id: unique identifier for the organization the deal is associated,

owner(Owner): each deal has a SalesSeek user who owns it (is responsible of),

owner_id(string): unique identifier for the SalesSeek user who owns this deal,

permissions: [???],

phase_id(string): id of the Funnel Phase this deal is,

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

phase_name(string): name of the Funnel Phase this deal is,

phase_number(int): position number of the Funnel Phase this deal is,

short_id(string): Alias which can be used as a unique identifier for the Bucket,

type(string): "opportunities",

value(number): total deal's size: sum of all bucket values,

comments(string): additional generic information not included on other fields (or custom fields),

is_favorite(boolean): true or false if this deal is favorite for the current SalesSeek user

}

 

Buckets(JSON): {

id (string): unique identifier for this bucket,

name (int): bucket name to be shown,

value (number): value for the current bucket inside this deal (depends on the currency),

default_value (string): ???

}

Organization(JSON): {

id (string): unique identifier for this organization,

name (int): organization name to be shown

}

Owner(JSON): {

id (string): unique identifier for the SalesSeek user who owns this deal,

name (int): name of the SalesSeek user who owns this deal

}

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

}

{
    abbreviation: "THS"
    buckets: [
      0:{
        name:Project Design, 
        value:20000, 
        default_value:20000, 
        id:7d2e38b6d
      },
      1:{
        name:Urbanization Plan, 
        value:3000, 
        default_value:3000, 
        id:7d2e38b6f
      },
    ]
    currency: "USD"
    custom_fields: {
      128d597afb923a:"https://www.google.com/NewStructure"
    }
    default_value: 23000
    expected_close_date: "2014-11-16T00:00:00.000Z"
    id: "184ffbf0aad9"
    latest_activity_in_days: 0
    name: "Town Hall"
    organization: {
      id: "8d6455f0c6"
      name: "Town Hall"
    }
    organization_id: "8d6455f0c6"
    files: [
        0: "edf66139dc71f"
    ]
    owner: {
      id: "2901f25"
      name: "Anna Karina"
    }
    owner_id: "2901f25"
    permissions: [
      0: "salesseek.core.view",
      1: "salesseek.core.all_permissions",
      2: "salesseek.core.edit"
    ]
    phase: {
      id: "4487844e"
      name: "Scheduled Visit"
      order: 2
    }
    phase_id: "4487844e"
    phase_last_changed: "2014-01-18T12:26:30.055763"
    phase_name: "Scheduled visit"
    phase_number: 2
    short_id: "5b540b028"
    type: "opportunities"
    value: 23000
    comments: "only 2 more companies had answered their RFQ"
  }

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
OpportunityIn-The  opportunity to be createdJSON
OpportunityOut-The opportunity created after the successful request including fields auto calculatedJSON

 


 

Get /opportunities/{opportunity_id} 

Provides the opportunity matching  opportunity_id

Returns the unique opportunity matching the  opportunity_id

Request URL

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

Response Type

Response content type: Opportunity

ModelExample of Response


Opportunity (JSON) {

currency(Enum): 3 letters abbreviation for the currency affecting all revenue buckets of this deal,

expected_close_date(timestamp): estimated close date for this deal, formatted as YYYY-MM-ddThh_mm_ss.msecs,

id (string): unique identifier for this opportunity,

name(string): Deal's name to be shown,

phase(Phase): details about the specific Funnel Phase this deal is,

buckets(Array[Buckets]): List of revenue bucket for this current deal,

custom_fields (Associative Array): Associative array organised in pairs of id: value,

default_value(number): ?????,

latest_activity_in_days(int): Amount of days since the last activity over this deal,

organization(Organization): A deal is always related to an organization (required),

organization_id: unique identifier for the organization the deal is associated,

owner(Owner): each deal has a SalesSeek user who owns it (is responsible of),

owner_id(string): unique identifier for the SalesSeek user who owns this deal,

permissions: [???],

phase_id(string): id of the Funnel Phase this deal is,

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

phase_name(string): name of the Funnel Phase this deal is,

phase_number(int): position number of the Funnel Phase this deal is,

short_id(string): Alias which can be used as a unique identifier for the Bucket,

type(string): "opportunities",

value(number): total deal's size: sum of all bucket values,

comments(string): additional generic information not included on other fields (or custom fields),

is_favorite(boolean): true or false if this deal is favorite for the current SalesSeek user

}

 

Buckets(JSON): {

id (string): unique identifier for this bucket,

name (int): bucket name to be shown,

value (number): value for the current bucket inside this deal (depends on the currency),

default_value (string): ???

}

Organization(JSON): {

id (string): unique identifier for this organization,

name (int): organization name to be shown

}

Owner(JSON): {

id (string): unique identifier for the SalesSeek user who owns this deal,

name (int): name of the SalesSeek user who owns this deal

}

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

}

{
    abbreviation: "F25"
    buckets: [
      0:{
        name:New Structure, 
        value:75000, 
        default_value:75000, 
        id:7d2e38b6d
      },
      1:{…}
    ]
    currency: "USD"
    custom_fields: {
      128d597afb923a:"https://www.google.com/NewStructure"
    }
    default_value: 75000
    expected_close_date: "2014-01-29T23:00:00"
    id: "184ffbf0aad9"
    latest_activity_in_days: 3
    name: "Refurbishing Opera House"
    organization: {
      id: "8d6455f0c6"
      name: "Opera House"
    }
    organization_id: "8d6455f0c6"
    owner: {
      id: "2901f25"
      name: "Anna Karina"
    }
    owner_id: "2901f25"
    permissions: [
      0: "salesseek.core.view",
      1: "salesseek.core.all_permissions",
      2: "salesseek.core.edit"
    ]
    phase: {
      id: "5b540b026a8"
      name: "Scheduled Visit"
      order: 2
    }
    phase_id: "5b540b026a8"
    phase_last_changed: "2014-01-18T12:26:30.055763"
    phase_name: "Scheduled visit"
    phase_number: 2
    short_id: "5b540b028"
    type: "opportunities"
    value: 75000
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 opportunity  _idInYThe id of opportunity to be getstring
 opportunity Out-The  requested opportunityJSON

 

 


 

 

PATCH /opportunity/{opportunity_id}

Update a specific opportunity by its ID

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

Request URL

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

Request Body
{
    buckets: [
        0:{
             id:"8bc7b81", 
             name:"Project Design", 
             value:20000
         },
         1:{
             id:"8bc7b82", 
             name:"Urbanization Plan", 
             value:7000}
    ]
    name: "Town Hall Complete Design",
    phase_id: "ec508c8fef3d"
}

 

Response Type

Response content type: JSON opportunity

ModelExample of Response


Opportunity (JSON) {

currency(Enum): 3 letters abbreviation for the currency affecting all revenue buckets of this deal,

expected_close_date(timestamp): estimated close date for this deal, formatted as YYYY-MM-ddThh_mm_ss.msecs,

id (string): unique identifier for this opportunity,

name(string): Deal's name to be shown,

phase(Phase): details about the specific Funnel Phase this deal is,

buckets(Array[Buckets]): List of revenue bucket for this current deal,

custom_fields (Associative Array): Associative array organised in pairs of id: value,

default_value(number): ?????,

latest_activity_in_days(int): Amount of days since the last activity over this deal,

organization(Organization): A deal is always related to an organization (required),

organization_id: unique identifier for the organization the deal is associated,

owner(Owner): each deal has a SalesSeek user who owns it (is responsible of),

owner_id(string): unique identifier for the SalesSeek user who owns this deal,

permissions: [???],

phase_id(string): id of the Funnel Phase this deal is,

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

phase_name(string): name of the Funnel Phase this deal is,

phase_number(int): position number of the Funnel Phase this deal is,

short_id(string): Alias which can be used as a unique identifier for the Bucket,

type(string): "opportunities",

value(number): total deal's size: sum of all bucket values,

comments(string): additional generic information not included on other fields (or custom fields),

is_favorite(boolean): true or false if this deal is favorite for the current SalesSeek user

}

 

Buckets(JSON): {

id (string): unique identifier for this bucket,

name (int): bucket name to be shown,

value (number): value for the current bucket inside this deal (depends on the currency),

default_value (string): ???

}

Organization(JSON): {

id (string): unique identifier for this organization,

name (int): organization name to be shown

}

Owner(JSON): {

id (string): unique identifier for the SalesSeek user who owns this deal,

name (int): name of the SalesSeek user who owns this deal

}

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

}

{
    abbreviation: "THS"
    buckets: [
      0:{
        name:Project Design, 
        value:20000, 
        default_value:20000, 
        id:7d2e38b6d
      },
      1:{
        name:Urbanization Plan, 
        value:7000, 
        default_value:7000, 
        id:7d2e38b6f
      },
    ]
    currency: "USD"
    custom_fields: {
      128d597afb923a:"https://www.google.com/NewStructure"
    }
    default_value: 23000
    expected_close_date: "2014-11-16T00:00:00.000Z"
    id: "184ffbf0aad9"
    latest_activity_in_days: 0
    name: "Town Hall Complete Design"
    organization: {
      id: "8d6455f0c6"
      name: "Town Hall"
    }
    organization_id: "8d6455f0c6"
    files: [
        0: "edf66139dc71f"
    ]
    owner: {
      id: "2901f25"
      name: "Anna Karina"
    }
    owner_id: "2901f25"
    permissions: [
      0: "salesseek.core.view",
      1: "salesseek.core.all_permissions",
      2: "salesseek.core.edit"
    ]
    phase: {
      id: "4487844e"
      name: "Scheduled Visit"
      order: 2
    }
    phase_id: "ec508c8fef3d"
    phase_last_changed: "2014-01-18T12:26:30.055763"
    phase_name: "Formal Offer"
    phase_number: 2
    short_id: "5b540b028"
    type: "opportunities"
    value: 27000
    comments: "only 2 more companies had answered their RFQ"
  }

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 opportunity_idInYThe id of the opportunity to be updatedstring
 opportunity InYThe subset of this opportunity model fields to be updatedJSON
 opportunity OutThe opportunity after the successful updateJSON

 

 


 

DELETE /opportunity/{opportunity_id}

Deletes a specific opportunity by its ID

Delete a opportunity by {opportunity_id}

Request URL

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

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 opportunity_idInYThe id of opportunity to be deletedstring

 


 

Get /opportunity/{opportunity_id}/ activity 

Provides the list of  activities  associated to this opportunity

Provides the list of  activities  associated to this opportunity   

Request URL

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

Response Type

Response content type: JSON Array[Activity]

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",
    opportunity_deleted: false,
    opportunity_id: "69d1f4ae62",
    opportunity_name: "Alex Van",
    opportunity_short_id: "69d1f3be62",
    last_modified_by_id: "2901efbcf25",
    latest: true,
    modified: "2014-01-18T16:21:31.680889",
    note: "emailed",
    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: "opportunities",
    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 /opportunities/{opportunity_id}/activities

Creates a new activity associated to opportunity {opportunity_id}

Creates a new activity associated to opportunity {opportunity_id}

Request URL

https://{client_id}.salesseek.net/api/opportunities/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"
	opportunity_deleted: false
	opportunity_id: "6b1664bbf95"
	opportunity_name: "Min Rome"
	opportunity_short_id: "6b1664bb5"
	last_modified_by_id: "2901ecbcf25"
	latest: true
	modified: "2014-01-19T20:48:03.810141"
	note: "emailed"
	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: "opportunities"
	type: "activities"
  }

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
activityOut-The opportunity created after the successful requestJSON

DELETE /opportunities/{opportunity_id}/activities/{activity_id}

Deletes a specific activity by its ID

Delete a specific activity which is associated to the opportunity by {activity_id}

Request URL

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

Response Type

Response content type: null

 

Parameters

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

PATCH /opportunities/{opportunity _id}/activities/{activity_id}

Update a specific activity by its ID, associated to an {opportunity_id}

Updates an activity by its ID and assocaited {opportunity _id} and Returns the resulting  activity . The fields updated are just the ones passed on the request body

Request URL

https://{client_id}.salesseek.net/api/opportunities/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"
	opportunity_deleted: false
	opportunity_id: "6b1664bbf95"
	opportunity_name: "Min Rome"
	opportunity_short_id: "6b1664bb5"
	last_modified_by_id: "2901ecbcf25"
	latest: true
	modified: "2014-01-19T20:48:03.810141"
	note: "emailed"
	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: "opportunities"
	type: "activities"
  }

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
user_idInYThe id of the opportunity which is associated this activitystring
activity_id InYThe id of the activity to be updatedJSON
activity OutThe opportunity after the successful updateJSON
  • No labels