Convert a lead to an opportunity
post
/crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads/action/convertLeadToOpty
This method lets you convert a lead to an opportunity.
Request
Path Parameters
-
AssetId(required): integer(int64)
The unique identifier of the asset.
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/vnd.oracle.adf.action+json
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): string
Returns "Successful" if the action completes successfully.
Examples
The following example shows how to convert the passed in lead identifier to an opportunity by submitting a POST request on the REST resource using cURL.
curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/assets/300100176220417/child/assetLeads/action/convertLeadToOpty
Example of Request Header
The following example shows the request header.
Content-Type - application/vnd.oracle.adf.action+json
Example of Request Body
The following example shows the request body to convert the passed in lead identifier to an opportunity.
{ "leadId": 300100129374358 }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "result": "Successful" }