APIs for 3DS Partners for sales domain (2.0.0)

Download OpenAPI specification:Download

License: Dassault Systèmes 2025

APIs exposed by 3DS to its partners and resellers for the sales functionnal domain.

leads-opportunities

This section defines the operations related to leads and opportunities for sales pipeline management.

These ressources are managed with 'MySalesPipeline' application which implements Dassault Systèmes sales process called 'LEVERAGE' in accordance with the VALUE Engagement framework. LEVERAGE is an acronym that stands for Listen, Explore, Validate, Establish, Reach AGreement & Experience.

Create a lead-opportunity object Deprecated

Main (production) server

https://apigw-prd.3ds.com/sales/api4partners/v0/leads-opportunities

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/sales/api4partners/v0/leads-opportunities

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/sales/api4partners/v0/leads-opportunities

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/sales/api4partners/v0/leads-opportunities

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/sales/api4partners/v0/leads-opportunities

Deprecated – v0. This endpoint will be removed in a future release as per our Partners API Lifecycle policy.
Use /sales/api4partners/v1/leads-opportunities instead.

Creates a lead-opportunity object from its attributes along with possible linked objects (contact, sales Rep)

Authorizations:

API Key: ApiKeyAuth

Request Body schema: application/json
required

request Body for creating a lead-opportunity

partnerId required	string Example: "200000000014442" Identification of partner LegalEntity in 3DS system.
required	object Core attributes of the lead-opportunity in case of creation.
required	Array of objects non-empty array of the various Offer Lines.
required	object identification of the target Customer Legal Entity
	Array of objects Customer Contact(s) informations
	Array of objects Partner Contact(s) informations

Responses

Request samples

Payload

Content type

application/json

Example

Basic Request for Creation of a lead

Minimal Request with mandatory attributes to create a lead with a single Offer Line, no customer Contact or partner contact.

{"partnerId": "200000000014442",
"leadOpportunity": {"partnerLeadOpportunityId": "PARTNER-CRM-LEAD-1A8R",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"status": "LEAD_OPEN",
"closeDate": "2025-06-01T18:46:51.326Z",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"currency": "EUR"
},
"offerLines": [{"amount": 13800,
"offerNameId": "3DEXPERIENCE_Design/Engineering_On_Premise",
"revenueType": "RENTAL_BOOKING"
}
],
"customerLegalEntity": {"name": "NEW CUSTOMER CORPORATION",
"city": "Stockdorf",
"country": "Germany"
}
}

Response samples

Content type

application/json

Response in case of a successful creation of a new leadOpportunity

{"dsLeadOpportunityId": "9YEL-Y3W56Q",
"partnerLeadOpportunityId": "PARTNER-CRM-LEAD-1A8R",
"action": "create",
"info": {"success": true,
"statusCode": 200,
"timestamp": null,
"traceId": null
},
"error": null
}

Update a lead-opportunity object Deprecated

Main (production) server

https://apigw-prd.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Deprecated – v0. This endpoint will be removed in a future release as per our Partners API Lifecycle policy.
Use /sales/api4partners/v1/leads-opportunities/{id} instead.

Update a lead-opportunity (partial updates on some attributes is recommended)

Authorizations:

API Key: ApiKeyAuth

path Parameters

required

string

3DS id of the lead-opportunity object to update

Request Body schema: application/json
required

request Body for updating a lead-opportunity object

partnerId required	string Example: "200000000014442" Identification of partner LegalEntity in 3DS system.
required	object Specific attributes of the lead-opportunity in case of update
	Array of objects array of the various Offer Lines.
	object identification of the target Customer Legal Entity
	Array of objects Customer Contact(s) informations
	Array of objects Partner Contact(s) informations

Responses

Request samples

Payload

Content type

application/json

Example

Example 1, updates status of lead.

Basic example of request body to update an existing lead-opportunity object.

{"leadOpportunity": {"partnerLeadOpportunityId": "CRM-LEAD-1234",
"status": "QUALIFIED"
}
}

Response samples

Content type

application/json

Response in case of a successful creation of a new leadOpportunity

{"info": {"success": true,
"statusCode": 200,
"timeStamp": null,
"traceId": null
},
"error": null,
"data": {"partnerLeadOpportunityId": "OPPY-12345",
"dsLeadOpportunityId": "XJSR-DZMFFT",
"action": "update"
}
}

Get details of a lead-opportunity object Deprecated

Main (production) server

https://apigw-prd.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/sales/api4partners/v0/leads-opportunities/{id}

Deprecated – v0. This endpoint will be removed in a future release as per our Partners API Lifecycle policy.
Use /sales/api4partners/v1/leads-opportunities/{id} instead.

gets details of a lead-opportunity object from its 3DS identifier.

Authorizations:

API Key: ApiKeyAuth

path Parameters

required

string

3DS id of the lead-opportunity object for which details are requested

Responses

Response samples

Content type

application/json

Successful retrieval of an existing leadOpportunity object

{"error": null,
"info": {"success": true,
"statusCode": 200,
"timeStamp": null,
"traceId": null
},
"data": {"leadOpportunity": {"partnerLeadOpportunityId": "API4PARTNERS-0813C",
"dsLeadOpportunityId": "HCRQ-F1LLDE",
"name": "TEST-0813C",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "WON",
"forecastCategory": "WON",
"closeDate": "2024-12-31T00:00:00.000Z",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"competitors": null,
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["EMPTY"
],
"reasonWonLostComment": "",
"gtmTacticId": null,
"description": "",
"nextMilestone": "",
"nextMilestoneDate": "",
"currency": "EUR",
"approvalStatus": "PRE_APPROVED",
"engagementType": "EXTEND",
"poInformation": "",
"poStatus": null,
"poNumber": null,
"sboIndicator": "EMPTY",
"sboStatus": null,
"sboNumber": null,
"growthType": "EMPTY",
"leadPriority": "EMPTY",
"levelOfInterest": "EMPTY",
"dsComment": "",
"partnerImportMode": "EMPTY",
"createdDate": "2025-08-13T12:35:03.775Z",
"modifiedDate": "2025-08-13T15:44:44.453Z",
"offerLines": [{"amount": 10000,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "UPFRONT"
},
{"amount": 11,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "RENTAL_BOOKING"
}
],
"customerContact": [{"phoneNumber": "9658252499",
"salutation": "MR",
"jobTitle": "",
"email": "dummy123_mail@mail.com",
"firstName": "F Name1",
"lastName": "L_Name2"
}
],
"partnerContact": null,
"customerLegalEntity": {"id": "200000000781989",
"dunsNumber": null,
"vatNumber": null,
"registrationId": null,
"name": null,
"city": null,
"country": null,
"addressLine1": null,
"statePrefecture": null,
"addressLine2": null,
"zipCode": null,
"websiteUrl": null
}
}
}
}

Search for leads-opportunities

Main (production) server

https://apigw-prd.3ds.com/sales/api4partners/v0/leads-opportunities/search

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/sales/api4partners/v0/leads-opportunities/search

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/sales/api4partners/v0/leads-opportunities/search

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/sales/api4partners/v0/leads-opportunities/search

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/sales/api4partners/v0/leads-opportunities/search

Searches for leads-opportunities using various search criteria (e.g. modifiedDate)

Authorizations:

API Key: ApiKeyAuth

Request Body schema: application/json
required

Request Body for searching leads-opportunities.

The request must include at least one of the following sub-objects:

modifiedDate
partnerLeadOpportunityId

These criteria will be combined using an AND operator if more than one is provided.

required

Array of objects or objects

Array

Any of

required

object

Search criterion on the last modification date/time of the leads-opportunities.

The maximum time window allowed for the search is 1 week / 7 days (between fromDateand toDate, calculated time to time). Both lower (fromDate) and upper (toDate) bounds need to be provided as no implict range calculation is done. Lower and upper bounds need to be consistent : fromDate has to be anterior to toDate.

partnerLeadOpportunityId

Array of arrays or strings or string

Examples: "PARTNER-ID-1234" ""

Search criterion on the id of the leads-opportunities as defined in partner CRM System.

This search criterion can be used for 2 main use cases :

Exact search for a particular lead-opportunitity id from Partner CRM system.
- Set the exact id searched for (e.g "PARTNER-ID-1234")
Retrieval of all leads-opportunitities that do not have a partnerLeadOpportunityId defined in 3DS CRM application (MySalesPipeline).
- These are typically marketing leads on which update by Partner could be required.
- Simply set an empty string ("")

Responses

Request samples

Payload

Content type

application/json

Example

search on modifiedDate criterion

Sample BodyRequest to search leads-opportunities based on 'modifiedDate' criterion.

{"data": [{"modifiedDate": {"fromDate": "2025-08-04T08:00:00Z",
"toDate": "2025-08-08T18:00:00Z"
}
}
]
}

Response samples

Content type

application/json

Sample response for successful search.

{"info": {"success": true,
"statusCode": 200,
"timeStamp": "2025-08-08T16:36:23Z",
"traceId": "785594df0cbd4f149d0ffbd7e0933820"
},
"error": null,
"data": [{"dsLeadOpportunityId": ["1FFC-7BQC5E",
"BYTK-COL4A0",
"5KSL-VLSWRX"
]
}
]
}

Create a lead-opportunity object

Main (production) server

https://apigw-prd.3ds.com/sales/api4partners/v1/leads-opportunities

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/sales/api4partners/v1/leads-opportunities

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/sales/api4partners/v1/leads-opportunities

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/sales/api4partners/v1/leads-opportunities

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/sales/api4partners/v1/leads-opportunities

Creates a lead-opportunity object from its attributes along with possible linked objects (contact, sales Rep)

Authorizations:

API Key: ApiKeyAuth

Request Body schema: application/json
required

request Body for creating a lead-opportunity

partnerId required	string Example: "200000000014442" Identification of partner LegalEntity in 3DS system.
required	object Core attributes of the lead-opportunity in case of creation.
required	Array of objects non-empty array of the various Offer Lines.
required	object identification of the target Customer Legal Entity
	Array of objects Customer Contact(s) informations
	Array of objects Partner Contact(s) informations

Responses

Request samples

Payload

Content type

application/json

Example

Basic Request for Creation of a lead

Minimal Request with mandatory attributes to create a lead with a single Offer Line, no customer Contact or partner contact.

{"partnerId": "200000000014442",
"leadOpportunity": {"partnerLeadOpportunityId": "PARTNER-CRM-LEAD-1A8R",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"status": "LEAD_OPEN",
"closeDate": "2025-06-01T18:46:51.326Z",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"currency": "EUR"
},
"offerLines": [{"amount": 13800,
"offerNameId": "3DEXPERIENCE_Design/Engineering_On_Premise",
"revenueType": "PxC"
}
],
"customerLegalEntity": {"name": "NEW CUSTOMER CORPORATION",
"city": "Stockdorf",
"country": "Germany"
}
}

Response samples

Content type

application/json

Response in case of a successful creation of a new leadOpportunity

{"dsLeadOpportunityId": "9YEL-Y3W56Q",
"partnerLeadOpportunityId": "PARTNER-CRM-LEAD-1A8R",
"action": "create",
"info": {"success": true,
"statusCode": 200,
"timestamp": null,
"traceId": null
},
"error": null
}

Update a lead-opportunity object

Main (production) server

https://apigw-prd.3ds.com/sales/api4partners/v1/leads-opportunities/{id}

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/sales/api4partners/v1/leads-opportunities/{id}

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/sales/api4partners/v1/leads-opportunities/{id}

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/sales/api4partners/v1/leads-opportunities/{id}

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/sales/api4partners/v1/leads-opportunities/{id}

Update a lead-opportunity (partial updates on some attributes is recommended)

Authorizations:

API Key: ApiKeyAuth

path Parameters

required

string

3DS id of the lead-opportunity object to update

Request Body schema: application/json
required

request Body for updating a lead-opportunity object

partnerId required	string Example: "200000000014442" Identification of partner LegalEntity in 3DS system.
required	object Specific attributes of the lead-opportunity in case of update
	Array of objects array of the various Offer Lines.
	object identification of the target Customer Legal Entity
	Array of objects Customer Contact(s) informations
	Array of objects Partner Contact(s) informations

Responses

Request samples

Payload

Content type

application/json

Example

Example 1, updates status of lead.

Basic example of request body to update an existing lead-opportunity object.

{"leadOpportunity": {"partnerLeadOpportunityId": "CRM-LEAD-1234",
"status": "QUALIFIED"
}
}

Response samples

Content type

application/json

Response in case of a successful creation of a new leadOpportunity

{"info": {"success": true,
"statusCode": 200,
"timeStamp": null,
"traceId": null
},
"error": null,
"data": {"partnerLeadOpportunityId": "OPPY-12345",
"dsLeadOpportunityId": "XJSR-DZMFFT",
"action": "update"
}
}

Get details of a lead-opportunity object

Main (production) server

https://apigw-prd.3ds.com/sales/api4partners/v1/leads-opportunities/{id}

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/sales/api4partners/v1/leads-opportunities/{id}

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/sales/api4partners/v1/leads-opportunities/{id}

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/sales/api4partners/v1/leads-opportunities/{id}

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/sales/api4partners/v1/leads-opportunities/{id}

gets details of a lead-opportunity object from its 3DS identifier.

Authorizations:

API Key: ApiKeyAuth

path Parameters

required

string

3DS id of the lead-opportunity object for which details are requested

Responses

Response samples

Content type

application/json

Successful retrieval of an existing leadOpportunity object

{"error": null,
"info": {"success": true,
"statusCode": 200,
"timeStamp": null,
"traceId": null
},
"data": {"leadOpportunity": {"partnerLeadOpportunityId": "API4PARTNERS-0813C",
"dsLeadOpportunityId": "HCRQ-F1LLDE",
"name": "TEST-0813C",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "WON",
"forecastCategory": "WON",
"closeDate": "2024-12-31T00:00:00.000Z",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"competitors": null,
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["EMPTY"
],
"reasonWonLostComment": "",
"gtmTacticId": null,
"description": "",
"nextMilestone": "",
"nextMilestoneDate": "",
"currency": "EUR",
"approvalStatus": "PRE_APPROVED",
"engagementType": "EXTEND",
"poInformation": "",
"poStatus": null,
"poNumber": null,
"sboIndicator": "EMPTY",
"sboStatus": null,
"sboNumber": null,
"growthType": "EMPTY",
"leadPriority": "EMPTY",
"levelOfInterest": "EMPTY",
"dsComment": "",
"partnerImportMode": "EMPTY",
"createdDate": "2025-08-13T12:35:03.775Z",
"modifiedDate": "2025-08-13T15:44:44.453Z",
"offerLines": [{"amount": 10000,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "PxC"
},
{"amount": 11,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "YxC"
}
],
"customerContact": [{"phoneNumber": "9658252499",
"salutation": "MR",
"jobTitle": "",
"email": "dummy123_mail@mail.com",
"firstName": "F Name1",
"lastName": "L_Name2"
}
],
"partnerContact": null,
"customerLegalEntity": {"id": "200000000781989",
"dunsNumber": null,
"vatNumber": null,
"registrationId": null,
"name": null,
"city": null,
"country": null,
"addressLine1": null,
"statePrefecture": null,
"addressLine2": null,
"zipCode": null,
"websiteUrl": null
}
}
}
}

portfolio-items

This section defines the operations related to sales portfolio-items.

The portfolio items are used in the definition of leads-opportunities in 'MySalesPipeline' application.

Search Sales portfolio items

Main (production) server

https://apigw-prd.3ds.com/sales/api4partners/v0/portfolio-items/search

Server for development by Partners (Non Production)

https://apigw-ppt.3ds.com/sales/api4partners/v0/portfolio-items/search

Server for Quality Assurance Testing (Non Production)

https://apigw-qal.3ds.com/sales/api4partners/v0/portfolio-items/search

Server for preprod validation (Non Production)

https://apigw-ptd.3ds.com/sales/api4partners/v0/portfolio-items/search

Server for postprod validation (Non Production)

https://apigw-ppd.3ds.com/sales/api4partners/v0/portfolio-items/search

Search Sales Portfolio Items. For now, no particular search criteria is offered, only pagination with skip & top query parameters.

Authorizations:

API Key: ApiKeyAuth

query Parameters

skip	integer >= 0 Default: 0 Number of items to skip in the search results.
top	integer >= 1 Default: 9999 Example: top=100 Maximum number of items to retrieve in search results.

Responses

Response samples

Content type

application/json

Successful search in portfolio items (with top=1)

{"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 3049,
"timeStamp": "2025-08-14T06:24:04.000Z"
},
"data": [{"salesPortfolioType": "Brand",
"salesPortfolioInfrastructure": "On Premise",
"salesPortfolioisOrderable": true,
"salesPortfolioLevel1": "CATIA",
"salesPortfolioLevel2": "CATIA V4",
"salesPortfolioLevel3": "MANUFACTURING",
"salesPortfolioId": "CLASS00001_ONPR_CATIAV4_SOL000038"
}
]
}

Schemas

partnerLeadOpportunityId

string

Unique Identifier of the lead-opportunity in the CRM system of the 3DS partner.

"OPPY-1004526"

dsOwnerEmail

string

email of the 3DS Partner Sales Manager (PSM).

Note : It is defaulted to the primary 3DS PSM if not provided at creation time.

"john.doe@3ds.com"

lead-opportunity-status

string

Enum	Description
LEAD_OPEN	-6 Open
QUALIFIED	-5 Qualified
ACCEPTED	-4 Accepted
OPPY_OPEN	-3 Open

… 4 more

Status of the lead-opportunity (LEVERAGE Processs)

"LEAD_OPEN"

forecastCategory

string

Enum	Description
UPSIDE	One or more major risks of closing business by the close date, however the customer stated an intention, as represented in the Win Plan, to place an order by the specified Close Date.
COMMIT	Commitment that this Opportunity will be won by the close date. All key steps to close by the close date have been agreed upon with the customer and there are no known major risks.
SAFE	The Purchase Order and agreements signed by the customer are received by 3DS, are being reviewed by Sales Operations and have been submitted to Finance.
WON	The signed Statement of work and Purchase Order are approved (by Finance)

… 3 more

Forecast Category is an assessment done by the Sales Expert to report his/her level of confidence that the Opportunity will close on the Close Date with the revenue amounts defined. Value is ignored at creation if status is ‘LEAD_OPEN’,’QUALIFIED’ or ’ACCEPTED’. if value is not provided at creation time, it defaults based on the following matrix :

status	default forecastCategory	forecastCategory values
-3 Open	Upside	Safe/Commit/Upside/Longshot
-2 validated	Upside	Safe/Commit/Upside/Longshot
-1 Established	Upside	Safe/Commit/Upside/Longshot
Won	Won	Won (set by the system)
Lost	Lost	Lost (set by the system)

"UPSIDE"

reason_won

string

Enum	Description
SOLUTION_FUNCT	Solution functionality
STRNG_VAL_PROP	Stronger value proposition
LWR_CST_OF_OWNRSHIP	Lower costs of ownership
LWR_IMPL_COST	Lower implementation costs

… 10 more

Identification of the reason a lead or an opportunity is won.

Note : At Creation time, if Value is Not provided, it will be defaulted to 'STRNG_VAL_PROP' (Stronger value proposition).

"STRNG_VAL_PROP"

reason_lost

string

Enum	Description
BETTER_COMP_OFFER	Better competition offer
CLIENT_DOES_NOT_SEE_VALUE	Client does not see value
LACK_OR_LOSS_OF_CHAMPION	Lack or loss of Champion
FUNC_GAP	Functional gap

… 39 more

A list of reason lost is used to identify the reason(s) for loss of an opportunity and for a Lead (which will give insight for the lessons learnt). Note : It is defaulted to No Project if value is Not provided during creation of the lead-opportunity.

"CLIENT_HAS_NO_MORE_BUDGET"

currency

string = 3 characters ^[A-Z]{3}$

Three-letter ISO 4217 currency code representing the transaction currency.

Must be exactly 3 uppercase alphabetic characters (e.g., USD for US Dollar, EUR for Euro, INR for Indian Ruppee).

"USD"

lead-opportunity_attributes

partnerLeadOpportunityId

string

Example: "OPPY-1004526"

Unique Identifier of the lead-opportunity in the CRM system of the 3DS partner.

name

string

Example: "Projekt Big-Picture Topic + MBSE (STEP 1+2)"

Name assigned to the lead-opportunity

dsOwnerEmail

string

Example: "john.doe@3ds.com"

email of the 3DS Partner Sales Manager (PSM).

Note : It is defaulted to the primary 3DS PSM if not provided at creation time.

status

string

Enum	Description
LEAD_OPEN	-6 Open
QUALIFIED	-5 Qualified
ACCEPTED	-4 Accepted
OPPY_OPEN	-3 Open

… 4 more

Example: "LEAD_OPEN"

Status of the lead-opportunity (LEVERAGE Processs)

forecastCategory

string

Enum	Description
UPSIDE	One or more major risks of closing business by the close date, however the customer stated an intention, as represented in the Win Plan, to place an order by the specified Close Date.
COMMIT	Commitment that this Opportunity will be won by the close date. All key steps to close by the close date have been agreed upon with the customer and there are no known major risks.
SAFE	The Purchase Order and agreements signed by the customer are received by 3DS, are being reviewed by Sales Operations and have been submitted to Finance.
WON	The signed Statement of work and Purchase Order are approved (by Finance)

… 3 more

Example: "UPSIDE"

status	default forecastCategory	forecastCategory values
-3 Open	Upside	Safe/Commit/Upside/Longshot
-2 validated	Upside	Safe/Commit/Upside/Longshot
-1 Established	Upside	Safe/Commit/Upside/Longshot
Won	Won	Won (set by the system)
Lost	Lost	Lost (set by the system)

closeDate

string <date-time>

Example: "2025-08-01T18:03:16.325Z"

Expected date for the closing of the sale in ISO 8601 format (like YYYY-MM-DDThh:mm:ss.sssZ)

cometCampaignCode

string

Example: "OC2DE17TAQ1C13018"

COMET Campaign code

reasonWon

Array of strings

Items Enum	Description
SOLUTION_FUNCT	Solution functionality
STRNG_VAL_PROP	Stronger value proposition
LWR_CST_OF_OWNRSHIP	Lower costs of ownership
LWR_IMPL_COST	Lower implementation costs

… 10 more

Example: ["STRNG_VAL_PROP"]

Identification of the reason a lead or an opportunity is won.

Note : At creation time, if value is not provided, it will be defaulted to STRNG_VAL_PROP (Stronger value proposition).

reasonLost

Array of strings

Items Enum	Description
BETTER_COMP_OFFER	Better competition offer
CLIENT_DOES_NOT_SEE_VALUE	Client does not see value
LACK_OR_LOSS_OF_CHAMPION	Lack or loss of Champion
FUNC_GAP	Functional gap

… 39 more

Example: ["CLIENT_HAS_NO_MORE_BUDGET"]

A list of reason lost is used to identify the reason(s) for loss of an opportunity and for a Lead (which will give insight for the lessons learnt).

Note : At creation time, if value is not provided, it will be defaulted to NO_PROJECT.

competitors

Array of strings

List of the competitors. In current state of the API, the list of valid values will be provided through direct communication with partners (mail or 3DSwym discussion).

reasonWonLostComment

string

Example: "The Customer has no budget"

Comment associated to WON or LOST reasons

gtmTacticId

string

identification of GoToMarket.

description

string

Example: "Projekt Dashboard - Big-Picture TopicPilotprojekt"

description associated to the lead-opportunity

nextMilestone

string

Example: "Next activity is to make a demo to the Customer"

Description of the next activity to be done

nextMilestoneDate

string <date-time>

Example: "2025-08-01T18:03:16.325Z"

Next Milestone date in ISO 8601 format (like YYYY-MM-DDThh:mm:ss.sssZ)

currency

string = 3 characters ^[A-Z]{3}$

Example: "USD"

Three-letter ISO 4217 currency code representing the transaction currency.

Must be exactly 3 uppercase alphabetic characters (e.g., USD for US Dollar, EUR for Euro, INR for Indian Ruppee).

{"partnerLeadOpportunityId": "OPPY-1004526",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "LEAD_OPEN",
"forecastCategory": "UPSIDE",
"closeDate": "2025-08-01T18:03:16.325Z",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["CLIENT_HAS_NO_MORE_BUDGET"
],
"competitors": ["string"
],
"reasonWonLostComment": "The Customer has no budget",
"gtmTacticId": "string",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"nextMilestone": "Next activity is to make a demo to the Customer",
"nextMilestoneDate": "2025-08-01T18:03:16.325Z",
"currency": "USD"
}

lead-opportunity_post

partnerLeadOpportunityId

required

string

Example: "OPPY-1004526"

Unique Identifier of the lead-opportunity in the CRM system of the 3DS partner.

name

required

string

Example: "Projekt Big-Picture Topic + MBSE (STEP 1+2)"

Name assigned to the lead-opportunity

dsOwnerEmail

string

Example: "john.doe@3ds.com"

email of the 3DS Partner Sales Manager (PSM).

Note : It is defaulted to the primary 3DS PSM if not provided at creation time.

status

required

string

Enum	Description
LEAD_OPEN	-6 Open
QUALIFIED	-5 Qualified
ACCEPTED	-4 Accepted
OPPY_OPEN	-3 Open

… 4 more

Example: "LEAD_OPEN"

Status of the lead-opportunity (LEVERAGE Processs)

forecastCategory

string

Enum	Description
UPSIDE	One or more major risks of closing business by the close date, however the customer stated an intention, as represented in the Win Plan, to place an order by the specified Close Date.
COMMIT	Commitment that this Opportunity will be won by the close date. All key steps to close by the close date have been agreed upon with the customer and there are no known major risks.
SAFE	The Purchase Order and agreements signed by the customer are received by 3DS, are being reviewed by Sales Operations and have been submitted to Finance.
WON	The signed Statement of work and Purchase Order are approved (by Finance)

… 3 more

Example: "UPSIDE"

status	default forecastCategory	forecastCategory values
-3 Open	Upside	Safe/Commit/Upside/Longshot
-2 validated	Upside	Safe/Commit/Upside/Longshot
-1 Established	Upside	Safe/Commit/Upside/Longshot
Won	Won	Won (set by the system)
Lost	Lost	Lost (set by the system)

closeDate

required

string <date-time>

Example: "2025-08-01T18:03:16.325Z"

Expected date for the closing of the sale in ISO 8601 format (like YYYY-MM-DDThh:mm:ss.sssZ)

cometCampaignCode

string

Example: "OC2DE17TAQ1C13018"

COMET Campaign code

reasonWon

Array of strings

Items Enum	Description
SOLUTION_FUNCT	Solution functionality
STRNG_VAL_PROP	Stronger value proposition
LWR_CST_OF_OWNRSHIP	Lower costs of ownership
LWR_IMPL_COST	Lower implementation costs

… 10 more

Example: ["STRNG_VAL_PROP"]

Identification of the reason a lead or an opportunity is won.

Note : At creation time, if value is not provided, it will be defaulted to STRNG_VAL_PROP (Stronger value proposition).

reasonLost

Array of strings

Items Enum	Description
BETTER_COMP_OFFER	Better competition offer
CLIENT_DOES_NOT_SEE_VALUE	Client does not see value
LACK_OR_LOSS_OF_CHAMPION	Lack or loss of Champion
FUNC_GAP	Functional gap

… 39 more

Example: ["CLIENT_HAS_NO_MORE_BUDGET"]

A list of reason lost is used to identify the reason(s) for loss of an opportunity and for a Lead (which will give insight for the lessons learnt).

Note : At creation time, if value is not provided, it will be defaulted to NO_PROJECT.

competitors

Array of strings

List of the competitors. In current state of the API, the list of valid values will be provided through direct communication with partners (mail or 3DSwym discussion).

reasonWonLostComment

string

Example: "The Customer has no budget"

Comment associated to WON or LOST reasons

gtmTacticId

string

identification of GoToMarket.

description

string

Example: "Projekt Dashboard - Big-Picture TopicPilotprojekt"

description associated to the lead-opportunity

nextMilestone

string

Example: "Next activity is to make a demo to the Customer"

Description of the next activity to be done

nextMilestoneDate

string <date-time>

Example: "2025-08-01T18:03:16.325Z"

Next Milestone date in ISO 8601 format (like YYYY-MM-DDThh:mm:ss.sssZ)

currency

required

string = 3 characters ^[A-Z]{3}$

Example: "USD"

Three-letter ISO 4217 currency code representing the transaction currency.

Must be exactly 3 uppercase alphabetic characters (e.g., USD for US Dollar, EUR for Euro, INR for Indian Ruppee).

{"partnerLeadOpportunityId": "OPPY-1004526",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "LEAD_OPEN",
"forecastCategory": "UPSIDE",
"closeDate": "2025-08-01T18:03:16.325Z",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["CLIENT_HAS_NO_MORE_BUDGET"
],
"competitors": ["string"
],
"reasonWonLostComment": "The Customer has no budget",
"gtmTacticId": "string",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"nextMilestone": "Next activity is to make a demo to the Customer",
"nextMilestoneDate": "2025-08-01T18:03:16.325Z",
"currency": "USD"
}

revenueType_deprecated_v0

string

Enum	Description
UPFRONT	Upfront
RENTAL_BOOKING	Rental Booking
SUPPORT_SERVICES	Support Services
SERVICES_SIGNING	Services Signing

… 1 more

The type of revenue

"UPFRONT"

offerLine_deprecated_v0

amount

number

Example: "13000"

Amount of the offer in the desgnated currency

offerNameId

required

string

Example: "MDMIND00022_PUBL_ISE00002687_IPE00021337"

Identification of the Offer.
Note: : In current state of the API, the list of valid values will be communicated directly to 3DS Partners via email or within 3DS Partner Swym Community.

revenueType

string

Deprecated

Enum	Description
UPFRONT	Upfront
RENTAL_BOOKING	Rental Booking
SUPPORT_SERVICES	Support Services
SERVICES_SIGNING	Services Signing

… 1 more

Example: "UPFRONT"

The type of revenue

{"amount": 13000,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "UPFRONT"
}

country

null or string

Country Location

"France"

customerLegalEntity

id	string or null Example: "200000000029188" 3DS site identifier
dunsNumber	string or null Example: "266257315" Duns & Bradstreet identification
vatNumber	string or null Example: "DE128212199" VAT (Value Added Tax) identification number
registrationId	string or null registration id of the company in the country
name required	string or null Example: "World Company Limited" the targeted name
city required	string or null Example: "San Francisco" City Location
country required	null or string Example: "France" Country Location
addressLine1	string or null Example: "Kraillinger Strasse 5" 1st line of the address
statePrefecture	string or null state / Prefecture
addressLine2	string or null 2nd line of the address (if needed)
zipCode	string or null Example: "82131" ZIP Postal code
websiteUrl	string or null Example: "www.world-company-limited.com" website URL of the company

{"id": "200000000029188",
"dunsNumber": "266257315",
"vatNumber": "DE128212199",
"registrationId": "string",
"name": "World Company Limited",
"city": "San Francisco",
"country": "France",
"addressLine1": "Kraillinger Strasse 5",
"statePrefecture": "string",
"addressLine2": "string",
"zipCode": "82131",
"websiteUrl": "www.world-company-limited.com"
}

customerContact

phoneNumber	string Example: "987654321" phone number of the Customer Contact
salutation	string Example: "M." Salution of the person : Mr., Ms., Dr., etc..
jobTitle	string Example: "Director of Reseearch & Development" Job title of the customer Contact
email required	string Example: "john.smith@world-company.com" email of the customer Contact
firstName required	string Example: "John" first name of the customer Contact
lastName required	string Example: "Smith" lastname of the customer Contact

{"phoneNumber": "987654321",
"salutation": "M.",
"jobTitle": "Director of Reseearch & Development",
"email": "john.smith@world-company.com",
"firstName": "John",
"lastName": "Smith"
}

partnerContact

salesRepEmail required	string Example: "john.doe@best-partner.com" email of the partner contact
salesRepFirstName required	string Example: "John" first Name of the partner Contact
salesRepLastName required	string Example: "Doe" last name of the partner contact

{"salesRepEmail": "john.doe@best-partner.com",
"salesRepFirstName": "John",
"salesRepLastName": "Doe"
}

post_leads-opportunities_data_deprecated_v0

partnerId required	string Example: "200000000014442" Identification of partner LegalEntity in 3DS system.
required	object Core attributes of the lead-opportunity in case of creation.
required	Array of objects non-empty array of the various Offer Lines.
required	object identification of the target Customer Legal Entity
	Array of objects Customer Contact(s) informations
	Array of objects Partner Contact(s) informations

{"partnerId": "200000000014442",
"leadOpportunity": {"partnerLeadOpportunityId": "OPPY-1004526",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "LEAD_OPEN",
"forecastCategory": "UPSIDE",
"closeDate": "2025-08-01T18:03:16.325Z",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["CLIENT_HAS_NO_MORE_BUDGET"
],
"competitors": ["string"
],
"reasonWonLostComment": "The Customer has no budget",
"gtmTacticId": "string",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"nextMilestone": "Next activity is to make a demo to the Customer",
"nextMilestoneDate": "2025-08-01T18:03:16.325Z",
"currency": "USD"
},
"offerLines": [{"amount": 13000,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "UPFRONT"
}
],
"customerLegalEntity": {"id": "200000000029188",
"dunsNumber": "266257315",
"vatNumber": "DE128212199",
"registrationId": "string",
"name": "World Company Limited",
"city": "San Francisco",
"country": "France",
"addressLine1": "Kraillinger Strasse 5",
"statePrefecture": "string",
"addressLine2": "string",
"zipCode": "82131",
"websiteUrl": "www.world-company-limited.com"
},
"customerContacts": [{"phoneNumber": "987654321",
"salutation": "M.",
"jobTitle": "Director of Reseearch & Development",
"email": "john.smith@world-company.com",
"firstName": "John",
"lastName": "Smith"
}
],
"partnerContacts": [{"salesRepEmail": "john.doe@best-partner.com",
"salesRepFirstName": "John",
"salesRepLastName": "Doe"
}
]
}

201_post_leads-opportunities

partnerLeadOpportunityId required	string Example: "OPPY-1004526" Unique Identifier of the lead-opportunity in the CRM system of the 3DS partner.
dsLeadOpportunityId required	string Example: "5ZOQ-LF35OK" 3DS id of the lead-opportunity
action required	string Example: "create" action performed
required	object Status of the request
	object or null

{"partnerLeadOpportunityId": "OPPY-1004526",
"dsLeadOpportunityId": "5ZOQ-LF35OK",
"action": "create",
"info": {"success": true,
"statusCode": 201,
"timestamp": "2025-06-30T12:36:46.556Z",
"traceId": "3d29ece30a064ea68c3f5f4a9f785c6f"
},
"error": {"code": "string",
"message": "string"
}
}

400_post_leads-opportunities

data required	null or object
required	object
required	object

{"data": null,
"info": {"success": false,
"statusCode": 400,
"timeStamp": "2025-06-30T12:36:46.556Z",
"traceId": "3d29ece30a064ea68c3f5f4a9f785c6f"
},
"error": {"code": "string",
"message": "string"
}
}

401_basic_unauthorized

message

required

string

{"message": "string"
}

403_basic_forbidden

message

required

string

{"message": "string"
}

406_leads-opportunities

	object
	object
	object

{"info": {"success": true,
"statusCode": 0,
"timeStamp": "string",
"traceId": "string"
},
"error": {"code": "string",
"message": "string"
},
"data": {"partnerLeadOpportunityId": null,
"dsLeadOpportunityId": null,
"action": null
}
}

429_too_many_requests

message

required

string

{"message": "string"
}

503_leads-opportunities

required	object
required	object
	object

{"info": {"success": false,
"statusCode": 503,
"timestamp": "2025-06-30T12:36:46.556Z",
"traceId": "3d29ece30a064ea68c3f5f4a9f785c6f"
},
"error": {"code": "ERR899",
"message": "Service currently unavailable, please try again later."
},
"data": {"partnerLeadOpportunityId": null,
"dsLeadOpportunityId": null,
"action": null
}
}

200_get_leads-opportunities_deprecated_v0

required	object
required	object
error	null no error in case of succees

{"data": {"leadOpportunity": {"partnerLeadOpportunityId": "OPPY-1004526",
"dsLeadOpportunityId": "5ZOQ-LF35OK",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "LEAD_OPEN",
"forecastCategory": "UPSIDE",
"closeDate": "2025-06-30",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["CLIENT_HAS_NO_MORE_BUDGET"
],
"competitors": ["string"
],
"reasonWonLostComment": "The Customer has no budget",
"gtmTacticId": "string",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"nextMilestone": "Next activity is to make a demo to the Customer",
"nextMilestoneDate": "2025-06-15",
"currency": "USD",
"approvalStatus": "string",
"engagementType": "string",
"poInformation": "string",
"poStatus": "string",
"poNumber": "string",
"sboIndicator": "string",
"sboStatus": "string",
"sboNumber": "string",
"growthType": "string",
"leadPriority": "string",
"levelOfInterest": "string",
"dsComment": "string",
"partnerImportMode": "string",
"createdDate": "string",
"modifiedDate": "string",
"offerLines": [{"amount": 13000,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "UPFRONT"
}
],
"customerLegalEntity": {"id": "200000000029188",
"dunsNumber": "266257315",
"vatNumber": "DE128212199",
"registrationId": "string",
"name": "World Company Limited",
"city": "San Francisco",
"country": "France",
"addressLine1": "Kraillinger Strasse 5",
"statePrefecture": "string",
"addressLine2": "string",
"zipCode": "82131",
"websiteUrl": "www.world-company-limited.com"
},
"customerContact": [{"phoneNumber": "987654321",
"salutation": "M.",
"jobTitle": "Director of Reseearch & Development",
"email": "john.smith@world-company.com",
"firstName": "John",
"lastName": "Smith"
}
],
"partnerContact": [{"salesRepEmail": "john.doe@best-partner.com",
"salesRepFirstName": "John",
"salesRepLastName": "Doe"
}
]
}
},
"info": {"success": true,
"statusCode": 0,
"timeStamp": null,
"traceId": null
},
"error": null
}

500_get_leads-opportunities

partnerId	null
data required	null
required	object
required	object

{"partnerId": null,
"data": null,
"info": {"success": true,
"statusCode": 0,
"timeStamp": "string",
"traceId": "string"
},
"error": {"code": "string",
"message": "string"
}
}

lead-opportunity_patch

partnerLeadOpportunityId

required

string

Example: "OPPY-1004526"

Unique Identifier of the lead-opportunity in the CRM system of the 3DS partner.

name

string

Example: "Projekt Big-Picture Topic + MBSE (STEP 1+2)"

Name assigned to the lead-opportunity

dsOwnerEmail

string

Example: "john.doe@3ds.com"

email of the 3DS Partner Sales Manager (PSM).

Note : It is defaulted to the primary 3DS PSM if not provided at creation time.

status

string

Enum	Description
LEAD_OPEN	-6 Open
QUALIFIED	-5 Qualified
ACCEPTED	-4 Accepted
OPPY_OPEN	-3 Open

… 4 more

Example: "LEAD_OPEN"

Status of the lead-opportunity (LEVERAGE Processs)

forecastCategory

string

Enum	Description
UPSIDE	One or more major risks of closing business by the close date, however the customer stated an intention, as represented in the Win Plan, to place an order by the specified Close Date.
COMMIT	Commitment that this Opportunity will be won by the close date. All key steps to close by the close date have been agreed upon with the customer and there are no known major risks.
SAFE	The Purchase Order and agreements signed by the customer are received by 3DS, are being reviewed by Sales Operations and have been submitted to Finance.
WON	The signed Statement of work and Purchase Order are approved (by Finance)

… 3 more

Example: "UPSIDE"

status	default forecastCategory	forecastCategory values
-3 Open	Upside	Safe/Commit/Upside/Longshot
-2 validated	Upside	Safe/Commit/Upside/Longshot
-1 Established	Upside	Safe/Commit/Upside/Longshot
Won	Won	Won (set by the system)
Lost	Lost	Lost (set by the system)

closeDate

string <date-time>

Example: "2025-08-01T18:03:16.325Z"

Expected date for the closing of the sale in ISO 8601 format (like YYYY-MM-DDThh:mm:ss.sssZ)

cometCampaignCode

string

Example: "OC2DE17TAQ1C13018"

COMET Campaign code

reasonWon

Array of strings

Items Enum	Description
SOLUTION_FUNCT	Solution functionality
STRNG_VAL_PROP	Stronger value proposition
LWR_CST_OF_OWNRSHIP	Lower costs of ownership
LWR_IMPL_COST	Lower implementation costs

… 10 more

Example: ["STRNG_VAL_PROP"]

Identification of the reason a lead or an opportunity is won.

Note : At creation time, if value is not provided, it will be defaulted to STRNG_VAL_PROP (Stronger value proposition).

reasonLost

Array of strings

Items Enum	Description
BETTER_COMP_OFFER	Better competition offer
CLIENT_DOES_NOT_SEE_VALUE	Client does not see value
LACK_OR_LOSS_OF_CHAMPION	Lack or loss of Champion
FUNC_GAP	Functional gap

… 39 more

Example: ["CLIENT_HAS_NO_MORE_BUDGET"]

A list of reason lost is used to identify the reason(s) for loss of an opportunity and for a Lead (which will give insight for the lessons learnt).

Note : At creation time, if value is not provided, it will be defaulted to NO_PROJECT.

competitors

Array of strings

List of the competitors. In current state of the API, the list of valid values will be provided through direct communication with partners (mail or 3DSwym discussion).

reasonWonLostComment

string

Example: "The Customer has no budget"

Comment associated to WON or LOST reasons

gtmTacticId

string

identification of GoToMarket.

description

string

Example: "Projekt Dashboard - Big-Picture TopicPilotprojekt"

description associated to the lead-opportunity

nextMilestone

string

Example: "Next activity is to make a demo to the Customer"

Description of the next activity to be done

nextMilestoneDate

string <date-time>

Example: "2025-08-01T18:03:16.325Z"

Next Milestone date in ISO 8601 format (like YYYY-MM-DDThh:mm:ss.sssZ)

currency

string = 3 characters ^[A-Z]{3}$

Example: "USD"

Three-letter ISO 4217 currency code representing the transaction currency.

Must be exactly 3 uppercase alphabetic characters (e.g., USD for US Dollar, EUR for Euro, INR for Indian Ruppee).

{"partnerLeadOpportunityId": "OPPY-1004526",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "LEAD_OPEN",
"forecastCategory": "UPSIDE",
"closeDate": "2025-08-01T18:03:16.325Z",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["CLIENT_HAS_NO_MORE_BUDGET"
],
"competitors": ["string"
],
"reasonWonLostComment": "The Customer has no budget",
"gtmTacticId": "string",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"nextMilestone": "Next activity is to make a demo to the Customer",
"nextMilestoneDate": "2025-08-01T18:03:16.325Z",
"currency": "USD"
}

patch_leads-opportunities_data_deprecated_v0

partnerId required	string Example: "200000000014442" Identification of partner LegalEntity in 3DS system.
required	object Specific attributes of the lead-opportunity in case of update
	Array of objects array of the various Offer Lines.
	object identification of the target Customer Legal Entity
	Array of objects Customer Contact(s) informations
	Array of objects Partner Contact(s) informations

{"partnerId": "200000000014442",
"leadOpportunity": {"partnerLeadOpportunityId": "OPPY-1004526",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "LEAD_OPEN",
"forecastCategory": "UPSIDE",
"closeDate": "2025-08-01T18:03:16.325Z",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["CLIENT_HAS_NO_MORE_BUDGET"
],
"competitors": ["string"
],
"reasonWonLostComment": "The Customer has no budget",
"gtmTacticId": "string",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"nextMilestone": "Next activity is to make a demo to the Customer",
"nextMilestoneDate": "2025-08-01T18:03:16.325Z",
"currency": "USD"
},
"offerLines": [{"amount": 13000,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "UPFRONT"
}
],
"customerLegalEntity": {"id": "200000000029188",
"dunsNumber": "266257315",
"vatNumber": "DE128212199",
"registrationId": "string",
"name": "World Company Limited",
"city": "San Francisco",
"country": "France",
"addressLine1": "Kraillinger Strasse 5",
"statePrefecture": "string",
"addressLine2": "string",
"zipCode": "82131",
"websiteUrl": "www.world-company-limited.com"
},
"customerContacts": [{"phoneNumber": "987654321",
"salutation": "M.",
"jobTitle": "Director of Reseearch & Development",
"email": "john.smith@world-company.com",
"firstName": "John",
"lastName": "Smith"
}
],
"partnerContacts": [{"salesRepEmail": "john.doe@best-partner.com",
"salesRepFirstName": "John",
"salesRepLastName": "Doe"
}
]
}

200_patch_leads-opportunities

required	object
required	object
error	null no error in case of succees

{"data": {"partnerLeadOpportunityId": "string",
"dsLeadOpportunityId": "string",
"action": "string"
},
"info": {"success": true,
"statusCode": 0,
"timeStamp": null,
"traceId": null
},
"error": null
}

400_patch_leads-opportunities

data required	object
required	object
errors required	object

{"data": { },
"info": {"success": true,
"statusCode": 0,
"estimateSearchCount": 0
},
"errors": { }
}

post_leads-opportunities_search

required

Array of objects or objects

Array

Any of

required

object

Search criterion on the last modification date/time of the leads-opportunities.

partnerLeadOpportunityId

Array of arrays or strings or string

Examples: "PARTNER-ID-1234" ""

Search criterion on the id of the leads-opportunities as defined in partner CRM System.

This search criterion can be used for 2 main use cases :

Exact search for a particular lead-opportunitity id from Partner CRM system.
- Set the exact id searched for (e.g "PARTNER-ID-1234")
Retrieval of all leads-opportunitities that do not have a partnerLeadOpportunityId defined in 3DS CRM application (MySalesPipeline).
- These are typically marketing leads on which update by Partner could be required.
- Simply set an empty string ("")

{"data": [{"modifiedDate": {"fromDate": "2024-08-01T14:30:00Z",
"toDate": "2024-08-08T08:30:00Z"
},
"partnerLeadOpportunityId": "PARTNER-ID-1234"
}
]
}

200_post_leads-opportunities_search

required	object
error	null no error in case of succees
required	Array of objects

{"info": {"success": true,
"statusCode": 0,
"timeStamp": "string",
"traceId": "string"
},
"error": null,
"data": [{"dsLeadOpportunityId": ["string"
]
}
]
}

portfolio-items_data

salesPortfolioType	string Example: "Brand" type of portfolio item
salesPortfolioInfrastructure	string Example: "On Premise" infrastructure type
salesPortfolioisOrderable	boolean Example: "true" Whether or not the item can be ordered
salesPortfolioLevel1	string Example: "3DEXPERIENCE" Level 1 of the description of the portfolio item
salesPortfolioLevel2	string Example: "Simulation" Level 2 of the description of the portfolio item
salesPortfolioLevel3	string Example: "Design to Manufacturing Process" Level 3 of the description of the portfolio item
salesPortfolioId	string Example: "CLASS00002_ONPR_PRTF077_SOL001277" type of portfolio item

{"salesPortfolioType": "Brand",
"salesPortfolioInfrastructure": "On Premise",
"salesPortfolioisOrderable": true,
"salesPortfolioLevel1": "3DEXPERIENCE",
"salesPortfolioLevel2": "Simulation",
"salesPortfolioLevel3": "Design to Manufacturing Process",
"salesPortfolioId": "CLASS00002_ONPR_PRTF077_SOL001277"
}

info_response_base_attributes

success	boolean Example: "true" true if operation succeeded or false in case of error.
statusCode	integer Example: "200" HTTP return code of the operation
estimatedSearchCount	integer Example: "6027" Total number of Results.

{"success": true,
"statusCode": 200,
"estimatedSearchCount": 6027
}

info_response_portfolio-items

success required	boolean Example: "true" true if operation succeeded or false in case of error.
statusCode required	integer Example: "200" HTTP return code of the operation
estimatedSearchCount required	integer Example: "6027" Total number of Results.
timeStamp required	string <date-time> Example: "2025-08-14T07:45:59.000Z" Timestamp of the operation.

{"success": true,
"statusCode": 200,
"estimatedSearchCount": 6027,
"timeStamp": "2025-08-14T07:45:59.000Z"
}

200_get_portfolio-items_search

required	Array of objects
required	object structure of the info part of the response for portfolio-item API.

{"data": [{"salesPortfolioType": "Brand",
"salesPortfolioInfrastructure": "On Premise",
"salesPortfolioisOrderable": true,
"salesPortfolioLevel1": "3DEXPERIENCE",
"salesPortfolioLevel2": "Simulation",
"salesPortfolioLevel3": "Design to Manufacturing Process",
"salesPortfolioId": "CLASS00002_ONPR_PRTF077_SOL001277"
}
],
"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 6027,
"timeStamp": "2025-08-14T07:45:59.000Z"
}
}

400_get_portfolio-items_search

required	object structure of the info part of the response for portfolio-item API.
required	object

{"info": {"success": true,
"statusCode": 200,
"estimatedSearchCount": 6027,
"timeStamp": "2025-08-14T07:45:59.000Z"
},
"error": {"code": "ERROR_004",
"message": "#top should be a positive, non zero integer"
}
}

revenueType

string

Enum	Description
PxC	Upfront
YxC	Yearly Rental Booking
QxC	Quarterly Rental Booking

The type of revenue

"PxC"

offerLine

amount

number

Example: "13000"

Amount of the offer in the designated currency

offerNameId

required

string

Identification of the Offer.
Note: Identification of the offerNameId can be found by consuming our portfolio-items service and locating the desired offer with the supplied hierarchical properties. Once identified, you can reference the "salesPortfolioId"

revenueType

string

Default: "PxC"

Enum	Description
PxC	Upfront
YxC	Yearly Rental Booking
QxC	Quarterly Rental Booking

Example: "PxC"

The type of revenue

startDate

string <date>

Start date of the offer in ISO 8601 format (YYYY-MM-DD) Note: startDate/endDate are only used for YxC/QxC

endDate

string <date>

End date of the offer in ISO 8601 format (YYYY-MM-DD) Note: startDate/endDate are only used for YxC/QxC

{"amount": 13000,
"offerNameId": "string",
"revenueType": "PxC",
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}

post_leads-opportunities_data

partnerId required	string Example: "200000000014442" Identification of partner LegalEntity in 3DS system.
required	object Core attributes of the lead-opportunity in case of creation.
required	Array of objects non-empty array of the various Offer Lines.
required	object identification of the target Customer Legal Entity
	Array of objects Customer Contact(s) informations
	Array of objects Partner Contact(s) informations

{"partnerId": "200000000014442",
"leadOpportunity": {"partnerLeadOpportunityId": "OPPY-1004526",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "LEAD_OPEN",
"forecastCategory": "UPSIDE",
"closeDate": "2025-08-01T18:03:16.325Z",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["CLIENT_HAS_NO_MORE_BUDGET"
],
"competitors": ["string"
],
"reasonWonLostComment": "The Customer has no budget",
"gtmTacticId": "string",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"nextMilestone": "Next activity is to make a demo to the Customer",
"nextMilestoneDate": "2025-08-01T18:03:16.325Z",
"currency": "USD"
},
"offerLines": [{"amount": 13000,
"offerNameId": "string",
"revenueType": "PxC",
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
],
"customerLegalEntity": {"id": "200000000029188",
"dunsNumber": "266257315",
"vatNumber": "DE128212199",
"registrationId": "string",
"name": "World Company Limited",
"city": "San Francisco",
"country": "France",
"addressLine1": "Kraillinger Strasse 5",
"statePrefecture": "string",
"addressLine2": "string",
"zipCode": "82131",
"websiteUrl": "www.world-company-limited.com"
},
"customerContacts": [{"phoneNumber": "987654321",
"salutation": "M.",
"jobTitle": "Director of Reseearch & Development",
"email": "john.smith@world-company.com",
"firstName": "John",
"lastName": "Smith"
}
],
"partnerContacts": [{"salesRepEmail": "john.doe@best-partner.com",
"salesRepFirstName": "John",
"salesRepLastName": "Doe"
}
]
}

revenueType_get

string

Enum	Description
PxC	Upfront
YxC	Yearly Rental Booking
QxC	Quarterly Rental Booking
SUPPORT_SERVICES	Support Services

… 2 more

The type of revenue

"PxC"

offerLine_get

amount

number

Example: "13000"

Amount of the offer in the desgnated currency

offerNameId

required

string

Example: "MDMIND00022_PUBL_ISE00002687_IPE00021337"

Identification of the Offer.
Note: Identification of the offerNameId can be found by consuming our portfolio-items service (link) and locating the desired offer with the supplied hierarchical properties. Once identified, you can reference the "salesPortfolioId"

revenueType

required

string

Enum	Description
PxC	Upfront
YxC	Yearly Rental Booking
QxC	Quarterly Rental Booking
SUPPORT_SERVICES	Support Services

… 2 more

Example: "SxC"

The type of revenue

startDate

string <date>

Start date of the offer in ISO 8601 format (YYYY-MM-DD)

endDate

string <date>

End date of the offer in ISO 8601 format (YYYY-MM-DD)

{"amount": 13000,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "PxC",
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}

200_get_leads-opportunities

required	object
required	object
error	null no error in case of succees

{"data": {"leadOpportunity": {"partnerLeadOpportunityId": "OPPY-1004526",
"dsLeadOpportunityId": "5ZOQ-LF35OK",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "LEAD_OPEN",
"forecastCategory": "UPSIDE",
"closeDate": "2025-06-30",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["CLIENT_HAS_NO_MORE_BUDGET"
],
"competitors": ["string"
],
"reasonWonLostComment": "The Customer has no budget",
"gtmTacticId": "string",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"nextMilestone": "Next activity is to make a demo to the Customer",
"nextMilestoneDate": "2025-06-15",
"currency": "USD",
"approvalStatus": "string",
"engagementType": "string",
"poInformation": "string",
"poStatus": "string",
"poNumber": "string",
"sboIndicator": "string",
"sboStatus": "string",
"sboNumber": "string",
"growthType": "string",
"leadPriority": "string",
"levelOfInterest": "string",
"dsComment": "string",
"partnerImportMode": "string",
"createdDate": "string",
"modifiedDate": "string",
"offerLines": [{"amount": 13000,
"offerNameId": "MDMIND00022_PUBL_ISE00002687_IPE00021337",
"revenueType": "PxC",
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
],
"customerLegalEntity": {"id": "200000000029188",
"dunsNumber": "266257315",
"vatNumber": "DE128212199",
"registrationId": "string",
"name": "World Company Limited",
"city": "San Francisco",
"country": "France",
"addressLine1": "Kraillinger Strasse 5",
"statePrefecture": "string",
"addressLine2": "string",
"zipCode": "82131",
"websiteUrl": "www.world-company-limited.com"
},
"customerContact": [{"phoneNumber": "987654321",
"salutation": "M.",
"jobTitle": "Director of Reseearch & Development",
"email": "john.smith@world-company.com",
"firstName": "John",
"lastName": "Smith"
}
],
"partnerContact": [{"salesRepEmail": "john.doe@best-partner.com",
"salesRepFirstName": "John",
"salesRepLastName": "Doe"
}
]
}
},
"info": {"success": true,
"statusCode": 0,
"timeStamp": null,
"traceId": null
},
"error": null
}

patch_leads-opportunities_data

partnerId required	string Example: "200000000014442" Identification of partner LegalEntity in 3DS system.
required	object Specific attributes of the lead-opportunity in case of update
	Array of objects array of the various Offer Lines.
	object identification of the target Customer Legal Entity
	Array of objects Customer Contact(s) informations
	Array of objects Partner Contact(s) informations

{"partnerId": "200000000014442",
"leadOpportunity": {"partnerLeadOpportunityId": "OPPY-1004526",
"name": "Projekt Big-Picture Topic + MBSE (STEP 1+2)",
"dsOwnerEmail": "john.doe@3ds.com",
"status": "LEAD_OPEN",
"forecastCategory": "UPSIDE",
"closeDate": "2025-08-01T18:03:16.325Z",
"cometCampaignCode": "OC2DE17TAQ1C13018",
"reasonWon": ["STRNG_VAL_PROP"
],
"reasonLost": ["CLIENT_HAS_NO_MORE_BUDGET"
],
"competitors": ["string"
],
"reasonWonLostComment": "The Customer has no budget",
"gtmTacticId": "string",
"description": "Projekt Dashboard - Big-Picture TopicPilotprojekt",
"nextMilestone": "Next activity is to make a demo to the Customer",
"nextMilestoneDate": "2025-08-01T18:03:16.325Z",
"currency": "USD"
},
"offerLines": [{"amount": 13000,
"offerNameId": "string",
"revenueType": "PxC",
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
],
"customerLegalEntity": {"id": "200000000029188",
"dunsNumber": "266257315",
"vatNumber": "DE128212199",
"registrationId": "string",
"name": "World Company Limited",
"city": "San Francisco",
"country": "France",
"addressLine1": "Kraillinger Strasse 5",
"statePrefecture": "string",
"addressLine2": "string",
"zipCode": "82131",
"websiteUrl": "www.world-company-limited.com"
},
"customerContacts": [{"phoneNumber": "987654321",
"salutation": "M.",
"jobTitle": "Director of Reseearch & Development",
"email": "john.smith@world-company.com",
"firstName": "John",
"lastName": "Smith"
}
],
"partnerContacts": [{"salesRepEmail": "john.doe@best-partner.com",
"salesRepFirstName": "John",
"salesRepLastName": "Doe"
}
]
}

APIs for 3DS Partners for sales domain (2.0.0)

leads-opportunities

Create a lead-opportunity object Deprecated

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update a lead-opportunity object Deprecated

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get details of a lead-opportunity object Deprecated

Authorizations:

path Parameters

Responses

Response samples

Search for leads-opportunities

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create a lead-opportunity object

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update a lead-opportunity object

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get details of a lead-opportunity object

Authorizations:

path Parameters

Responses

Response samples

portfolio-items

Search Sales portfolio items

Authorizations:

query Parameters

Responses

Response samples

Schemas

partnerLeadOpportunityId

dsOwnerEmail

lead-opportunity-status

forecastCategory

reason_won

reason_lost

currency

lead-opportunity_attributes

lead-opportunity_post

revenueType_deprecated_v0

offerLine_deprecated_v0

country

customerLegalEntity

customerContact

partnerContact

post_leads-opportunities_data_deprecated_v0

201_post_leads-opportunities

400_post_leads-opportunities

401_basic_unauthorized

403_basic_forbidden

406_leads-opportunities

429_too_many_requests

503_leads-opportunities

200_get_leads-opportunities_deprecated_v0

500_get_leads-opportunities

lead-opportunity_patch

patch_leads-opportunities_data_deprecated_v0

200_patch_leads-opportunities

400_patch_leads-opportunities

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required