Revoke Access to a Shared Opportunity
The Share an Opportunity API lets you share an opportunity with a sales user for a particular duration.
This API lets you revoke a user’s access to that opportunity before the specified duration has elapsed. You’ll get a request Id in the response if the call is successful. You can use this request Id in the Get Status of a Share/Revoke Request API to see if it has been processed.
Note:
- Ensure you have met the prerequisites listed under Entity Sharing before using this API.
- All parameters in the request are mandatory except AccessType. The default value is 1 = read.
API URL
URL
POST
https://{host}/v2/EntityAccess.svc/Revoke?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
[
{
"UserId":"96105aa0-61f2-11ea-8109-022edb41208c",
"Entity":5,
"EntityType":3,
"EntityId":"f85f3b60-bec7-47c8-8fcd-ae5d9df2d0e5",
"AccessType":2
}
]
Request Parameters
| Parameter | Description |
|---|---|
| UserId | Id of the sales user who’s access to the opportunity you want to revoke. You can use the Get Users API to retrieve user Ids. |
| Entity | Currently, the only entity you can share is 5 = opportunity. Pass 5 here. |
| EntityType | This is the entity the opportunity is being shared with. Currently, you can only share an opportunity with 3 = user. Pass 3 here. |
| EntityId | Pass the |
| AccessType | Defines if you want to give the user read or write access to the opportunity.
|
Response
200 OK
Content-Type: application/json
{
"Status":"Success",
"Message":{
"Id":"32409773120843389d9b99e622fceac3"
}
}
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. |
