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

Get /phases

Provides the entire list of Phases 

Returns the entire list of Phases.

SalesSeek system is based on the Sales Funnel, it is a representation of the list of opportunities (or deals) organized from top to bottom as a sequence of Phases representing the current Deal state from the Lead until the won (or lost)

Request URL

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

Response Type

Response content type: JSON Array[Phases]

ModelExample of Response

Array[Phases]

 

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),

phase_type(Enum): there are 3 different type of phases:

  • user: if this is an active deal,
  • won: if the deal was closed as won,
  • lost: if the deal was closed as lost

default_weight(number): weight representing a percentage (0..1) of probability to close a deal on this current phase, configured in SalesSeek Settings,

hint(string): a brief description about what makes a Deal to be included in this phase

short_id(string): shorter unique identifier for this phase,

type(string): "phases"

}

 

[
  0:{
    default_weight: 0.1
	hint: "Positive step towards wanting to talk to us. 
    Business Card, Registration, Contacted Directly."
	id: "be3436"
	name: "Contact Made"
	order: 0
	phase_type: "user"
	short_id: "be3436"
	type: "phases"
  },
  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
responseOut-Resulting list of PhasesArray[Phase]

 

 


 

 

POST /phases

Creates a new Phase 

Creates a new Phase and Returns the resulting element 

Request URL

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

Request Body
{
	comments: "Comments",
	default_duration: null,
	default_weight: 0.6,
	hint: "All deals pending for a specific quotation",
	name: "Quotation",
	order: 0
  }

 

Response Type

Response content type: JSON Phase

ModelExample of Response

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),

phase_type(Enum): there are 3 different type of phases:

  • user: if this is an active deal,
  • won: if the deal was closed as won,
  • lost: if the deal was closed as lost

default_weight(number): weight representing a percentage (0..1) of probability to close a deal on this current phase, configured in SalesSeek Settings,

hint(string): a brief description about what makes a Deal to be included in this phase

short_id(string): shorter unique identifier for this phase,

type(string): "phases"

}

{
    default_weight: 0.6,
	hint: "All deals pending for a specific quotation.",
	id: "be3436",
	name: "Quotation",
	order: 0,
	phase_type: "user",
	short_id: "be3436",
	type: "phases"
}

Parameters

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

 

 


 

 

PATCH /phases/{phase_id}

Update a specific Phase by its ID

Updates a Phase by its {phase_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/phases/69d1fbe62  

 

Request Body
{
  order:2
}

 

Response Type

Response content type: JSON XXXXXXXXXXXXXX

ModelExample of Response

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),

phase_type(Enum): there are 3 different type of phases:

  • user: if this is an active deal,
  • won: if the deal was closed as won,
  • lost: if the deal was closed as lost

default_weight(number): weight representing a percentage (0..1) of probability to close a deal on this current phase, configured in SalesSeek Settings,

hint(string): a brief description about what makes a Deal to be included in this phase

short_id(string): shorter unique identifier for this phase,

type(string): "phases"

}

{
    default_weight: 0.6,
	hint: "All deals pending for a specific quotation.",
	id: "69d1fbe62",
	name: "Quotation",
	order: 2,
	phase_type: "user",
	short_id: "69d1fbe62",
	type: "phases"
}

 

Parameters

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

 

 


 

 

DELETE /phases/{phase_id}

Deletes a specific Phase by its ID

Deletes a Phase by it {phase_id}

Request URL

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

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 Phase_idInYThe id of Phase to be deletedstring
  • No labels