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

POST /clients

Creates a new SalesSeek client 

Creates a new client and Returns the resulting element 

Request URL

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

Request Body
{
	default_currency: "USD",
	facebook_page_id: null,
	marketing_groups: {
		groups: [
			"ee3bd434341",
			"843211b409b",
			"23d8531424b"
		]
	}
	name: "My Travel Agency"
	short_id: "my_travel_agency"
	type: "clients"
}

 

Response Type

Response content type: JSON Client

ModelExample of Response

Client (JSON) {

client_id (String): unique string to identify this client,

currencies (Currencies): pairs of names and values of accepted currencies, configured on the as additional from the default one,

default_currency (Enum): unique 3-char id for the default currency (the rest of the currencies will have an associated conversion rate against the default currency), see the table of currencies,

facebook_page_id (String): Unique ID for the real facebook page configured as a Social Lead Source. null if it haven't been configured.

id (String): unique string to identify this client,

marketing_groups (Groups_list): list of groups which the logged user in the current SalesSeek system has configured to be shown as his own set of groups in the Marketing dashboard

name (String) : Name of the SalesSeek System Client,

 short_id (String): alternative id or alias to reference to this client

type (string): its always clients

}

Groups_list (JSON) {

groups (Array[String]): list of groups ids which the logged user in the current SalesSeek system has configured to be shown as his own set of groups in the Marketing dashboard

}


Currencies (AssociativeCollection)

{

/* List of Pairs of <Key> and <Value>, relates a currency Key with an exchange rate to be converted to the default currency*/

<Value>(number): vale of the conversion rate from this currency to the default currency, ie: if the default currency is USD, GBP can be added with an aprox value of 0.62,

<Key>(string): 3 chars id for the currency, check the following table for all available currencies:

 

 Click here for all available currencies...

Key

Currency Name

AUD

Australian Dollar
BRLBrasilian Real
CADCanadian Dollar
CHFSwiss Franc
CLPChilean Peso
CNY

Chinese Yuan

CZKCzech Koruna
DKKDanish Krone
EUREuro
FJDFiji Dollar
GBPBritish Pound
HKDHong Kong Dollar
HNLHonduran Lempira
HUFHungarian Forint
IDRIndonesian Rupiah
ILSIsraeli New Shekel
INRIndonesian Rupee
ISKIceland Krona
JPYJapansese Yen
KRWKorean Won
MXNMexican Peso
MYRMalasyan Ringgit
NOKNorwegian Krone
NZDNew Zealand Dollar
PHPPhilippine Peso
PKRPakistan Rupee
PLNPolish Zloty
RUBRussian Ruble
SEKSwedish Krona
SGDSingapore Dollar
THBThai Baht
TRYTurkish Lira
TWDTaiwan Dollar
ZARSouth Africa Rand

}


{
	client_id: "6454746f1"
	currencies: {}
	default_currency: "USD"
	facebook_page_id: null
	id: "6454746f1"
	marketing_groups: {
		groups: [
				"ee3bd434341",
				"843211b409b",
				"23d8531424b"
			]
	}
	name: "My Travel Agency"
	short_id: "my_travel_agency"
	type: "clients"
}

Parameters

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

 

 


 

Get /clients/{Client_id} 

Provides the Marketing Groups for the Client_id

Returns the list of groups configured to be the focus on the marketing dashboard for the specific client.

Request URL

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

Response Type

Response content type: Marketing_Groups

ModelExample of Response

Groups_list (JSON) {

groups (Array[String]): list of groups ids which the logged user in the current SalesSeek system has configured to be shown as his own set of groups in the Marketing dashboard

}


{
    groups: [
				"ee3bd434341",
				"843211b409b",
				"23d8531424b"
	]
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
responseOut-The list of groups to be the focus of the Marketing Dashboard Analysis for this ClientJSON

 

 


 

 

PATCH /clients/{Client_id}

Update a specific Client by its ID

Updates a Client by its {Client_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/clients/69d1fbe62  

 

Request Body
{
  marketing_groups: {
	groups: [
		"ee3bd72234",
		"845312409b",
		"4221117d85"
	]
  }
}

 

Response Type

Response content type: Client(JSON)

ModelExample of Response

Client (JSON) {

client_id (String): unique string to identify this client,

currencies (Currencies): pairs of names and values of accepted currencies, configured on the as additional from the default one,

default_currency (Enum): unique 3-char id for the default currency (the rest of the currencies will have an associated conversion rate against the default currency), see the table of currencies,

facebook_page_id (String): Unique ID for the real facebook page configured as a Social Lead Source. null if it haven't been configured.

id (String): unique string to identify this client,

marketing_groups (Groups_list): list of groups which the logged user in the current SalesSeek system has configured to be shown as his own set of groups in the Marketing dashboard

name (String) : Name of the SalesSeek System Client,

 short_id (String): alternative id or alias to reference to this client

type (string): its always clients

}

Groups_list (JSON) {

groups (Array[String]): list of groups ids which the logged user in the current SalesSeek system has configured to be shown as his own set of groups in the Marketing dashboard

}


Currencies (AssociativeCollection)

{

/* List of Pairs of <Key> and <Value>, relates a currency Key with an exchange rate to be converted to the default currency*/

<Value>(number): vale of the conversion rate from this currency to the default currency, ie: if the default currency is USD, GBP can be added with an aprox value of 0.62,

<Key>(string): 3 chars id for the currency, check the following table for all available currencies:

 

 Click here for all available currencies...

Key

Currency Name

AUD

Australian Dollar
BRLBrasilian Real
CADCanadian Dollar
CHFSwiss Franc
CLPChilean Peso
CNY

Chinese Yuan

CZKCzech Koruna
DKKDanish Krone
EUREuro
FJDFiji Dollar
GBPBritish Pound
HKDHong Kong Dollar
HNLHonduran Lempira
HUFHungarian Forint
IDRIndonesian Rupiah
ILSIsraeli New Shekel
INRIndonesian Rupee
ISKIceland Krona
JPYJapansese Yen
KRWKorean Won
MXNMexican Peso
MYRMalasyan Ringgit
NOKNorwegian Krone
NZDNew Zealand Dollar
PHPPhilippine Peso
PKRPakistan Rupee
PLNPolish Zloty
RUBRussian Ruble
SEKSwedish Krona
SGDSingapore Dollar
THBThai Baht
TRYTurkish Lira
TWDTaiwan Dollar
ZARSouth Africa Rand

}


{
	client_id: "69d1fbe62"
	currencies: {}
	default_currency: "USD"
	facebook_page_id: null
	id: "69d1fbe62"
	marketing_groups: {
		groups: [
				"ee3bd434341",
				"843211b409b",
				"23d8531424b"
			]
	}
	name: "My Travel Agency"
	short_id: "my_travel_agency"
	type: "clients"
}

 

Parameters

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

 

 


 

Get /client_name

Provides the human readable string of the client name for this SalesSeek account 

Provides the client name for this SalesSeek account

Request URL

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

Response Type

Response content type: String

ModelExample of Response
String
"Design Studio"

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
responseOut-Client name for this SalesSeek accountString
  • No labels