|
OpportunityContactRole
An object that represents a contact role.
Supported API Calls: List | Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID representing the OpportunityContactRole object. When adding a new OpportunityContactRole the value must be 0. |
|
OpportunityId |
integer |
The ID for the parent Opportunity object. |
|
ContactId |
integer |
The ID for the contact ID that is given a role. |
|
Role |
string (100) |
ID to set the contact role's Role drop-down box. Value should be equal to a ContactRole object's ID field. |
|
Contact |
Contact |
Contact object of the Contact associated with the Contact Role. |
|
IsPrimary |
boolean |
Flag that indicates the contact role is the primary contact. |
|
ReceiveSaleQuote |
boolean |
Flag that indicates the contact role is the contact that receives a sales quote. |
List
Description
Returns a list of contact roles associated with the specified opportunity
URL
https://{company}.bluecamroo.com/api/OpportunityContactRole/list?opportunityId={opportunityId}
HTTP Method
GET
Parameters
None
Data Return
Returns the list of contact roles in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
401: Not authorized (you need to log in)
Get
Description
Returns details for the specified contact role.
URL
https://{company}.bluecamroo.com/api/opportunitycontactrole/get/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns the opportunitycontactrole object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds an opportunity's contact role.
URL
https://{company}.bluecamroo.com/api/opportunitycontactrole/add
HTTP Method
POST
Parameters
An opportunitycontactrole object
Data Return
Returns the an opportunitycontactrole object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Updates an opportunitycontactrole object.
URL
https://{company}.bluecamroo.com/api/opportunitycontactrole/update
HTTP Method
PUT
Parameters
An opportunitycontactrole object
Data Return
Returns the an opportunitycontactrole object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the contract role.
URL
https://{company}.bluecamroo.com/api/opportunitycontactrole/delete/{id}
HTTP Method
DELETE
Parameters
None
Data Return
None
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|