Get Metadata of an Opportunity Type
Returns the properties of all the fields for the selected opportunity type. To obtain the Opportunity Type Code, navigate to My Profile>Settings>Opportunities>Opportunity Types, and against an opportunity type, you’ll find the code.
API URL
URL
GET
https://{host}/v2/OpportunityManagement.svc/GetOpportunityTypeMetadata? accessKey=AccessKey&secretKey=SecretKey&code=code
URL Parameters
| Parameter | Description |
|---|---|
| code | This is the event code for the opportunity type. You can find this by navigating to My Profile>Settings>Opportunities>Opportunity Type. It is listed under "Code". |
Response
200 OK
Content-Type: application/json
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
