Show/hide List Operations Expand Operations

Base

PUT /base/push-deal.json

push deal into base

Documentation
Sandbox

Documentation

push lead for base.

Requirements

Name	Requirement	Type	Description
_format	xml\|json

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /base/push-lead/{idSale}

push deal into base

Documentation
Sandbox

Documentation

push deal into base.

Requirements

Name	Requirement	Type	Description
_format	xml\|json
idSale

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /base/put-status-lead/{id}/{idLeadBase}

Update status sales lead

Documentation
Sandbox

Documentation

put Status Lead By Base.

Requirements

Name	Requirement	Type	Description
_format	xml\|json
id
idLeadBase

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred
206	Returend when Swift_SwiftException occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Business

POST /business/create-business-sales.{_format}

create business

Documentation
Sandbox

Documentation

Create business sales.

Requirements

Name	Requirement	Type	Description
_format	xml\|json

Parameters

Parameter	Type	Required?	Description
partner	string	true	partner business
globalOffer	string	true	globalOffer business
ratio	string	true	ratio business

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /business/create-business.{_format}

create business

Documentation
Sandbox

Documentation

Create business.

Requirements

Name	Requirement	Type	Description
_format	xml\|json

Parameters

Parameter	Type	Required?	Description
partner	string	true	partner business
objectif	string	true	object business
challenge	string	true	challenge business
strenght	string	true	strenght business
weaknesse	string	true	weaknesse business
opportunity	string	true	opportunity business
threat	string	true	threat business
strategic	string	true	strategic business
revenue	string	true	revenue business
firstClient	string	true	firstClient business

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /business/create-marketing.{_format}

create marketing

Documentation
Sandbox

Documentation

Create marketing.

Requirements

Name	Requirement	Type	Description
_format	xml\|json

Parameters

Parameter	Type	Required?	Description
partner	string	true	marketing partner
description	string	true	marketing description
objectives	string	true	marketing objectives
status	string	true	marketing status
comment	string	true	marketing comment
leadGenerat	string	true	marketing leadGenerat
cost	string	true	marketing cost
support	string	true	marketing support
date	string	true	marketing date

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /business/get-business/{idPartner}.{_format}

Get business

Documentation
Sandbox

Documentation

Get business.

Requirements

Name	Requirement	Type	Description
idPartner	\d+	integer	partner id
_format	xml\|json

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /business/get-list-marketing/{idPartner}.{_format}

Get marketing

Documentation
Sandbox

Documentation

Get marketing.

Requirements

Name	Requirement	Type	Description
idPartner	\d+	integer	partner id
_format	xml\|json

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /business/get-marketing-by-id/{id}.{_format}

Get marketing

Documentation
Sandbox

Documentation

Get marketing.

Requirements

Name	Requirement	Type	Description
id	\d+	integer	id marketing
_format	xml\|json

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /business/update-business-sales/{id}.{_format}

update business

Documentation
Sandbox

Documentation

update business sales.

Requirements

Name	Requirement	Type	Description
id	\d+	integer	id
_format	xml\|json

Parameters

Parameter	Type	Required?	Description
partner	string	true	partner business
globalOffer	string	true	globalOffer business
ratio	string	true	ratio business

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /business/update-business/{id}.{_format}

update business

Documentation
Sandbox

Documentation

update business.

Requirements

Name	Requirement	Type	Description
id	\d+	integer	id
_format	xml\|json

Parameters

Parameter	Type	Required?	Description
partner	string	true	partner business
objectif	string	true	object business
challenge	string	true	challenge business
strenght	string	true	strenght business
weaknesse	string	true	weaknesse business
opportunity	string	true	opportunity business
threat	string	true	threat business
strategic	string	true	strategic business
revenue	string	true	revenue business
firstClient	string	true	firstClient business

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /business/update-marketing/{id}.{_format}

update marketing

Documentation
Sandbox

Documentation

update marketing.

Requirements

Name	Requirement	Type	Description
id	\d+	integer	id
_format	xml\|json

Parameters

Parameter	Type	Required?	Description
partner	string	true	marketing partner
description	string	true	marketing description
objectives	string	true	marketing objectives
status	string	true	marketing status
comment	string	true	marketing comment
leadGenerat	string	true	marketing leadGenerat
cost	string	true	marketing cost
support	string	true	marketing support
date	string	true	marketing date

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

BusinessCore

POST /{locale}/api/business-core/add/{idCustomer}.{_format}

add Business Core

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
idCustomer	\d+	integer	customer id
_format	xml\|json
locale		type

Parameters

Parameter	Type	Required?	Format	Description
label	string	true		label industry

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /{locale}/api/business-core/delete/{id}/{idCustomer}.{_format}

delete Business Core

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
idCustomer	\d+	integer	customer id
_format	xml\|json
locale		type
id

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /{locale}/api/business-core/edit/{id}/{idCustomer}.{_format}

edit Business Core

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
idCustomer	\d+	integer	customer id
_format	xml\|json
locale		type
id

Parameters

Parameter	Type	Required?	Format	Description
label	string	true		label industry

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /{locale}/api/business-core/get/{id}/{idCustomer}.{_format}

get Business Core

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+	integer	id
_format	xml\|json
locale		type
idCustomer		type

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /{locale}/api/business-core/list/{idCustomer}.{_format}

Get all Business Core

Documentation
Sandbox

Documentation

Get all Business Core.

Requirements

Name	Requirement	Type	Description
_format	xml\|json
locale
idCustomer

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

CertificationLevel

POST /{locale}/api/certification-level/add/{idCustomer}.{_format}

add Certification Level

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
idCustomer	\d+	integer	customer id
_format	xml\|json
locale		type

Parameters

Parameter	Type	Required?	Format	Description
label	string	true		label certification
logo	string	true		logo certification

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /{locale}/api/certification-level/delete/{id}/{idCustomer}.{_format}

delete Certification Level

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
idCustomer	\d+	integer	customer id
_format	xml\|json
locale		type
id

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /{locale}/api/certification-level/edit/{id}/{idCustomer}.{_format}

edit Certification Level

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
idCustomer	\d+	integer	customer id
_format	xml\|json
locale		type
id

Parameters

Parameter	Type	Required?	Format	Description
label	string	true		label certification
logo	string	true		logo certification

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /{locale}/api/certification-level/get/{id}/{idCustomer}.{_format}

get Certification Level

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+	integer	id
_format	xml\|json
locale		type
idCustomer		type

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /{locale}/api/certification-level/list/{idCustomer}.{_format}

Get all Certification Level

Documentation
Sandbox

Documentation

Get all Certification Level.

Requirements

Name	Requirement	Type	Description
_format	xml\|json
locale
idCustomer

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Cockpit

POST /cockpit/{locale}/widget-associate/{idUser}/{type}.{_format}

associate cockpit by user

Documentation
Sandbox

Documentation

Associate cockpit by user.

Requirements

Name	Requirement	Type	Description
idUser	\d+	integer	id user
type	\d+	string	type of module
_format	xml\|json
locale

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /cockpit/{locale}/widget-set/{idUser}/{type}.{_format}

set cockpit by user

Documentation
Sandbox

Documentation

Set cockpit by user.

Requirements

Name	Requirement	Type	Description
idUser	\d+	integer	id user
type	\d+	string	type of module
_format	xml\|json
locale

Parameters

Parameter	Type	Required?	Format	Description
widgets	array	true		list widgets

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /cockpit/{locale}/widget/list-disable-widget/{idUser}/{type}.{_format}

Get disable widget by user

Documentation
Sandbox

Documentation

Get disable widget by user.

Requirements

Name	Requirement	Type	Description
_format	xml\|json
locale
idUser
type

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /cockpit/{locale}/widget/list-user-widget/{idUser}/{type}.{_format}

Get all widget by user

Documentation
Sandbox

Documentation

Get all widget by user.

Requirements

Name	Requirement	Type	Description
_format	xml\|json
locale
idUser
type

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /cockpit/{locale}/widget/list-widget/{type}.{_format}

Get all widget by type

Documentation
Sandbox

Documentation

Get all widget by type.

Requirements

Name	Requirement	Type	Description
type	\d+	string	widget type
_format	xml\|json
locale

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /cockpit/{locale}/widget/list.{_format}

Get all widget

Documentation
Sandbox

Documentation

Get all widget.

Requirements

Name	Requirement	Type	Description
_format	xml\|json
locale

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Collateral

POST /co-branding/{locale}/affect-collateral-profile/{id}/{customer}.{_format}

Affect Profile for collateral

Documentation
Sandbox

Documentation

Affect Profile for collateral.

Requirements

Name	Requirement	Type	Description
customer	\d+	integer	customer id
_format	xml\|json
locale
id

Parameters

Parameter	Type	Required?	Format	Description
collaterals[]	string	true		collaterals

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /co-branding/{locale}/affect-tag-collateral/{id}/{customer}.{_format}

Affect tag for Collateral

Documentation
Sandbox

Documentation

Affect tag for Collateral.

Requirements

Name	Requirement	Type	Description
customer	\d+	integer	customer id
_format	xml\|json
locale
id

Parameters

Parameter	Type	Required?	Format	Description
tagCollaterals[]	string	true		tagCollaterals

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /co-branding/{locale}/create-collateral.{_format}

Create a new Collateral

Documentation
Sandbox

Documentation

Create a new Collateral.

Requirements

Name	Requirement	Type	Description
_format	xml\|json
locale

Parameters

Parameter	Type	Required?	Description
nameCollateral	string	true	Nom
language	string	true	language
status	string	true	status
tagCollaterals[]	string	true	tagCollaterals
fileUpload	string	true	fileUpload
zoning	string	true	fileUpload
picto	string	true	fileUpload
dimension	string	true	dimension
customer	string	true	Customer

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred
206	Returend when Swift_SwiftException occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /co-branding/{locale}/delete-collateral/{id}/{customer}.{_format}

Delete a Collateral

Documentation
Sandbox

Documentation

Delete a Collateral.

Requirements

Name	Requirement	Type	Description
id	\d+	integer	collateral id
_format	xml\|json
locale
customer

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /co-branding/{locale}/delete-generate-pdf/{partner}/{customer}/{id}.{_format}

Delete a Generate PDF

Documentation
Sandbox

Documentation

Delete a Generate PDF.

Requirements

Name	Requirement	Type	Description
partner	\d+	integer	partner id
_format	xml\|json
locale
customer
id		integer	Identifier of the Generate object to remove.

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /co-branding/{locale}/generate-collateral/{customer}/{partner}.{_format}

Get all Collateral

Documentation
Sandbox

Documentation

Get all generete Collateral.

Requirements

Name	Requirement	Type	Description
partner	\d+	integer	partner id
_format	xml\|json
locale
customer

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /co-branding/{locale}/generate-collateral/{customer}/{partner}/{id}.{_format}

Get all Collateral

Documentation
Sandbox

Documentation

Get all generete Collateral.

Requirements

Name	Requirement	Type	Description
partner	\d+	integer	partner id
_format	xml\|json
locale
customer
id

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /co-branding/{locale}/generate-pdf/{customer}/{id}.{_format}

generate PDF

Documentation
Sandbox

Documentation

generate PDF

Requirements

Name	Requirement	Type	Description
id	\d+	integer	partner id
_format	xml\|json
locale
customer

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /co-branding/{locale}/get-collateral-pagination/{customer}/{start}/{limit}.{_format}

Get all Collateral pagination

Documentation
Sandbox

Documentation

Get all Collateral pagination.

Requirements

Name	Requirement	Type	Description
customer	\d+	integer	customer id
_format	xml\|json
locale
start
limit

Parameters

Parameter	Type	Required?	Description
search	string	false	search
column	string	false	column
dir	string	false	dir

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /co-branding/{locale}/get-collateral-partner/{id}/{customer}.{_format}

get Collateral

Documentation
Sandbox

Documentation

get Collateral partner.

Requirements

Name	Requirement	Type	Description
customer	\d+	integer	customer id
_format	xml\|json
locale
id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /co-branding/{locale}/get-collateral/{customer}.{_format}

Get all Collateral

Documentation
Sandbox

Documentation

Get all Collateral.

Requirements

Name	Requirement	Type	Description
customer	\d+	integer	customer id
_format	xml\|json
locale

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /co-branding/{locale}/get-collateral/{id}/{customer}.{_format}

get Collateral

Documentation
Sandbox

Documentation

get Collateral.

Requirements

Name	Requirement	Type	Description
customer	\d+	integer	customer id
_format	xml\|json
locale
id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /co-branding/{locale}/get-number-collateral/{customer}.{_format}

Get Number Collateral

Documentation
Sandbox

Documentation

Get Number Collateral.

Requirements

Name	Requirement	Type	Description
customer	\d+	integer	customer id
_format	xml\|json
locale

Parameters

Parameter	Type	Required?	Format	Description
search	string	false		search

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /co-branding/{locale}/get-partner-collateral/{customer}.{_format}

Get all Collateral Partner

Documentation
Sandbox

Documentation

Get all Collateral Partner.

Requirements

Name	Requirement	Type	Description
customer	\d+	integer	customer id
_format	xml\|json
locale

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /co-branding/{locale}/post-generate-collateral.{_format}

Create a new generate Collateral

Documentation
Sandbox

Documentation

Create a new generate Collateral.

Requirements

Name	Requirement	Type	Description
_format	xml\|json
locale

Parameters

Parameter	Type	Required?	Description
zoning	string	true	zoning (json)
partner	string	true	id Partner
collateral	string	true	id collateral
customer	string	true	Customer
nameFileGenerate	string	true	nameFileGenerate

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred
206	Returend when Swift_SwiftException occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /co-branding/{locale}/put-status-collateral/{id}/{customer}.{_format}

Put status a Collateral

Documentation
Sandbox

Documentation

Put status a Collateral.

Requirements

Name	Requirement	Type	Description
customer	\d+	integer	customer id
_format	xml\|json
locale
id		integer	Identifier of the TagCollateral object to remove.

Parameters

Parameter	Type	Required?	Format	Description
status	string	true		status

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /co-branding/{locale}/update-collateral/{id}.{_format}

Edit a new Collateral

Documentation
Sandbox

Documentation

Edit a new Collateral.

Requirements

Name	Requirement	Type	Description
_format	xml\|json
locale
id

Parameters

Parameter	Type	Required?	Description
nameCollateral	string	true	Nom
language	string	true	language
status	string	true	status
tagCollaterals[]	string	true	tagCollaterals
fileUpload	string	true	fileUpload
zoning	string	true	fileUpload
picto	string	true	fileUpload
dimension	string	true	dimension
customer	string	true	Customer

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred
206	Returend when Swift_SwiftException occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Connectors

POST /onboarding/getConnectionBase.{_format}

get connection base

Documentation
Sandbox

Documentation

get connection base.

Requirements

Name	Requirement	Type	Description
_format	xml\|json

Parameters

Parameter	Type	Required?	Format	Description
key	string	true		key api

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /onboarding/getKey/{idCustomer}/{typeConnector}.{_format}

Get Connector

Documentation
Sandbox

Documentation

Get Connector.

Requirements

Name	Requirement	Type	Description
typeConnector	\d+	integer	type Connector (base, salesforce, etc.)
_format	xml\|json
idCustomer

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /onboarding/postKey.{_format}

create connector

Documentation
Sandbox

Documentation

Create connector.

Requirements

Name	Requirement	Type	Description
_format	xml\|json

Parameters

Parameter	Type	Required?	Description
key	string	true	key api
customer	string	true	id customer
typeConnector	string	true	type connector

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /onboarding/putKey/{id}.{_format}

Update connector

Documentation
Sandbox

Documentation

Update connector.

Requirements

Name	Requirement	Type	Description
id	\d+	integer	id
_format	xml\|json

Parameters

Parameter	Type	Required?	Description
key	string	true	key api
customer	string	true	id customer
typeConnector	string	true	type connector

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Customer

POST /customers/create.{_format}

add customer

Documentation
Sandbox

Documentation

add customer.

Requirements

Name	Requirement	Type	Description
_format	xml\|json

Parameters

Parameter	Type	Required?	Description
society	string	true	society of customer
address	string	true	address of customer
zipCode	string	true	zipCode of customer
city	string	true	city of customer
country	string	true	country of customer
fax	string	true	fax of customer
phone	string	true	phone of customer
email	string	true	email of customer
firstname	string	true	firstname of customer
lastname	string	true	lastname of customer
language	string	true	language of customer

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /customers/update_password.{_format}

Update a password for customer

Documentation
Sandbox

Documentation

Update a password for customer.

Requirements

Name	Requirement	Type	Description
_format	xml\|json

Parameters

Parameter	Type	Required?	Description
token	string	true	token of customer
email	string	true	email of customer
plainPassword	string	true	password of customer

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred
206	Returend when Swift_SwiftException occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

FamilyTagCoBranding

POST /co-branding/{locale}/create-family-tag-collateral.{_format}

Create a new FamilyTagCollateral

Documentation
Sandbox

Documentation

Create a new Family Tag Collateral.

Requirements

Name	Requirement	Type	Description
_format	xml\|json
locale

Parameters

Parameter	Type	Required?	Description
name	string	true	Nom
description	string	true	Description
customer	string	true	Customer

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred
206	Returend when Swift_SwiftException occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /co-branding/{locale}/delete-family-tag-collateral/{id}/{customer}.{_format}

Delete a given familyTagCollateral

Documentation
Sandbox

Documentation

Delete a given familyTagCollateral.

Requirements

Name	Requirement	Type	Description
id	\d+	integer	family tag collateral id
_format	xml\|json
locale
customer

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /co-branding/{locale}/get-family-and-tag-collateral/{customer}.{_format}

Get all getAllFamilyAndTag

Documentation
Sandbox

Documentation

Get all family and tag.

Requirements

Name	Requirement	Type	Description
customer	\d+	integer	customer id
_format	xml\|json
locale

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /co-branding/{locale}/get-family-tag-collateral/{customer}.{_format}

Get all FamilyTagCoBranding

Documentation
Sandbox

Documentation

Get all family tag.

Requirements

Name	Requirement	Type	Description
customer	\d+	integer	customer id
_format	xml\|json
locale

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /co-branding/{locale}/get-family-tag-collateral/{id}/{customer}.{_format}

Get all FamilyTagCoBranding

Documentation
Sandbox

Documentation

Get family tag.

Requirements

Name	Requirement	Type	Description
customer	\d+	integer	customer id
_format	xml\|json
locale
id

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /co-branding/{locale}/update-family-tag-collateral/{id}.{_format}

Update an existing partnerCategory

Documentation
Sandbox

Documentation

Update an existing Family Tag Collateral.

Requirements

Name	Requirement	Type	Description
id	\d+	integer	partnerCategory id
_format	xml\|json
locale

Parameters

Parameter	Type	Required?	Format	Description
name	string	true	{not blank}	Nom
description	string	false		Description
customer	string	false		Customer

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

FileTag

POST /{locale}/api/file_tag/add/{idCustomer}.{_format}

add File Tag

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
idCustomer	\d+	integer	customer id
_format	xml\|json
locale

Parameters

Parameter	Type	Required?	Format	Description
label	string	true		label File for Tag

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /{locale}/api/file_tag/delete/{id}/{idCustomer}.{_format}

delete File Tag

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
idCustomer	\d+	integer	customer id
_format	xml\|json
locale		type
id

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /{locale}/api/file_tag/edit/{id}/{idCustomer}.{_format}

edit File Tag

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
idCustomer	\d+	integer	customer id
_format	xml\|json
locale		type
id

Parameters

Parameter	Type	Required?	Format	Description
label	string	true		label industry

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /{locale}/api/file_tag/get/{id}/{idCustomer}.{_format}

get File Tag

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+	integer	id
_format	xml\|json
locale		type
idCustomer		type

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /{locale}/api/file_tag/list/{idCustomer}.{_format}

Get all File Tag

Documentation
Sandbox

Documentation

Get all File Tag .

Requirements

Name	Requirement	Type	Description
_format	xml\|json
locale
idCustomer

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Form builder

PUT /form-builder/form-builder-delete/{idCustomer}.{_format}

Delete form

Documentation
Sandbox

Documentation

DELETE Form.

Requirements

Name	Requirement	Type	Description
idCustomer	\d+	integer	id customer
_format	xml\|json

Parameters

Parameter	Type	Required?	Format	Description
idForm	string	true		form

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /form-builder/form-builder-get/{form_builder}/{idCustomer}.{_format}

Get Form builder

Documentation
Sandbox

Documentation

Get form builder.

Requirements

Name	Requirement	Type	Description
idCustomer	\d+	integer	id customer
_format	xml\|json
form_builder

Parameters

Parameter	Type	Required?	Format	Description
form_builder	integer	true		Form Builder ID

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /form-builder/form-builder-post/{idCustomer}.{_format}

POST form

Documentation
Sandbox

Documentation

POST form.

Requirements

Name	Requirement	Type	Description
idCustomer	\d+	integer	id customer
_format	xml\|json

Parameters

Parameter	Type	Required?	Format	Description
forms	string	true		grids

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /form-builder/form-builder-type-get.{_format}

Get Form builder type

Documentation
Sandbox

Documentation

Get Grid.

Requirements

Name	Requirement	Type	Description
_format	xml\|json

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Formula

POST /pricing-tools/formula-add/{idCustomer}.{_format}

create Formula

Documentation
Sandbox

Documentation

Create Formula.

Requirements

Name	Requirement	Type	Description
idCustomer	\d+	integer	id customer
_format	xml\|json

Parameters

Parameter	Type	Required?	Description
title	string	true	title formula
formBuilder	integer	true	formBuilder
formula	text	true	code formula

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when not found
500	Returned when an exception occurred

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /pricing-tools/formula-delete/{id}/{idCustomer}.{_format}

delete formula

API documentation

Base

PUT /base/push-deal.json

Documentation

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /base/push-lead/{idSale}

Documentation

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /base/put-status-lead/{id}/{idLeadBase}

Documentation

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Business

POST /business/create-business-sales.{_format}

Documentation

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /business/create-business.{_format}

Documentation

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /business/create-marketing.{_format}

Documentation

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /business/get-business/{idPartner}.{_format}

Documentation

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /business/get-list-marketing/{idPartner}.{_format}